Subscribe or unsubscribe

Server URLloading...

PUT

/v1/email-preferences

Send

Authorization

Body

Sets whether this account receives product announcements. subscribed: false is the unsubscribe.

Idempotent, and it works for an address the mail provider has never seen: opting out is recorded against the address either way, so a preference set before the account was ever added to the list survives being added to it later.

Messages carry their own one-click unsubscribe link as well. This endpoint exists for the settings screen, not as the only way out - an unsubscribe that requires signing in first is not one.

Response Body

curl -X PUT "https://example.com/v1/email-preferences" \  -H "Content-Type: application/json" \  -d '{    "subscribed": true  }'

{  "subscribed": true}