Unsubscribe a contact from a list
Mark the contact's membership on this list as UNSUBSCRIBED. Accepts SENDING_ONLY (pk_*) keys so it can back a public preference form. Idempotent — unsubscribing an address that is not a member succeeds.
Once a membership is UNSUBSCRIBED, a later POST /api/lists/{id}/subscribe needs allowResubscribe: true to reverse it.
Requires the lists:write scope — Create, rename, and delete your subscriber lists.
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringList id.
1 <= lengthapplication/json- body
Body for POST /api/lists/{id}/unsubscribe.
email*stringemailContact unsubscribed
application/json- response
Echoes the address that was unsubscribed.
success*truetruedata*curl -X POST 'https://api.sendly.now/api/lists/string/unsubscribe' \ -H 'Content-Type: application/json' \ -d '{ "email": "user@example.com"}'{ "success": true, "data": { "email": "user@example.com" }}