bulk_unsubscribe
Unsubscribe from several mailing lists at once using thread IDs. Sends one-click unsubscribe requests per distinct sender and reports duplicates, failures, and timeouts.
Instructions
Unsubscribe from several mailing lists in one call, one thread id per list. Threads are processed SEQUENTIALLY, and at most ONE request is made per sender — a second thread from a sender whose request already went out is reported with duplicateOf and no request (and says so when it advertises a DIFFERENT endpoint, i.e. is probably a separate list from the same sender). The whole call shares a 60-second budget; threads left over when it runs out come back with skippedOutOfTime and a reason, so re-running with the remaining ids finishes the job. Like unsubscribe, there is no URL parameter: every endpoint comes from that thread's own List-Unsubscribe header. Only RFC 8058 one-click senders are contacted; the rest come back with their alternatives in options. Partial success is reported, never hidden: a thread that cannot be read or whose endpoint fails becomes an entry with a reason, and the remaining threads still run. USE WHEN: clearing out several newsletters at once — pair with list_subscriptions, which gives you the sender rows and their newestThreadId. DO NOT USE: for one thread (use unsubscribe), or to find candidates (use list_subscriptions — it contacts nobody). SIDE EFFECTS: up to one outbound HTTPS request per DISTINCT sender (plus up to 3 redirects each) — the only non-Google hosts mailwarden ever contacts. Each confirms to that sender that the address is live, and none of it can be undone. The mailbox itself is not changed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| threadIds | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| results | Yes | ||
| attempted | Yes | ||
| requested | Yes | ||
| unsubscribed | Yes | ||
| skippedOutOfTime | Yes | ||
| skippedDuplicates | Yes |