Skip to main content
A convenience flip that opts a contact out: sets subscribed to false and stamps the moment they unsubscribed. POST /v1/contacts/{id}/unsubscribe

Path parameters

string
required
The contact id to opt out.
This endpoint takes no request body.
App-level signal, not a delivery block. Unsubscribing flips the contact’s subscribed flag — an app-level signal you honor in your own sending logic. It does not add the address to the suppression list. To hard-block delivery, add a suppression as well.

Request

Response

Returns 200 OK with the contact, now showing subscribed: false and a non-null unsubscribedAt. The call is idempotent. An unknown id returns 404 not_found.
200 OK