Lists

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.

post/api/lists/{id}/unsubscribe

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/lists/{id}/unsubscribe
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token

Path parameters

idstring required

List id.

Request body

emailstring email required

Response

Contact unsubscribed

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.