WoyraDocs
Get an API key

Leave the list a message came from

POST/v1/mail/messages/{id}/unsubscribe

Mailboxes · Requires an API key

The best way the list allows: a one-click request to the list (RFC 8058), else an email to the list's address from this mailbox, else the list's own page, returned as url for the app to open. Only https and mailto addresses are used.

Parameters

NameInDescription
idrequiredpath
mailboxqueryThe token's own mailbox. Any other address is refused with 403.

Example

curl -X POST https://api.woyra.io/v1/mail/messages/email_01J.../unsubscribe \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 What was done.

FieldTypeDescription
objectrequiredstring
One of unsubscribe.
methodrequiredstring
One of one-click, mail, link.
urlstringWith method link: the page to open.

Errors

StatusCodes
400invalid_request, unsupported_version
401authentication_required, invalid_api_key
404not_found, product_not_offered

Also in Mailboxes