Unsubscribe from a mailing list
unsubscribeLeaves the mailing list a thread came from (a newsletter, a promotional mailing, a notification list), in the name of the mailbox it arrived in, with what the last message received in the thread offers: one POST to the list's unsubscribe address when it accepts a one-click unsubscription, otherwise a short mail from the box to the list's own address. get_conversation says, in "unsubscribe" on each message, whether it offers a way out ("one_click", "mailto") and when the box took it ("done_at"). Call it once the person has said they want to leave that list: it is their decision about the mail they receive. The answer is {status, method, detail}: "unsubscribed" when the list took the request, "already" when the box had already left from that message (nothing is sent again), "not_offered" when no message of the thread offers a way out, and "refused" when nothing was done, with why in "detail". A thread filed as spam, and a sender that failed DMARC, are refused on purpose: unsubscribing from spam tells its sender that the address exists and is read, and report_spam is the gesture for those. A list that answers with an error is refused with its HTTP code.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| conversation_id | Yes | The id of the conversation, as list_conversations gives it. |