POST/api/v1/projects/{project_id}/subscribers/{subscriber_id}/unsubscribe

`unsubscribe_subscriber`

Unsubscribes a subscriber: from its list, or (scope: "project") the address from every list of the project. The address is suppressed first (list:<list_id> or project), then the subscriptions become unsubscribed.

Call it: when someone asks to stop getting mail.
Needs: an admin key with project_id, or a project key with scope write (its own project; the argument is ignored); works on a deleted list too.
Returns: the subscriber after the call, the same as POST /api/v1/projects/{project_id}/subscribers/{subscriber_id}/unsubscribe; a repeat changes nothing.

Arguments

object
subscriber_idstring · uuidrequired

The subscriber’s id.
project_idstring · uuid | null

The subscriber’s project. An admin key must pass it; a project key’s own project is used and this is ignored.
scopestring

list (left out: the same): from the subscriber’s list; project: the address from every list of the project.

example list

No other arguments are accepted.

Result

The result comes back as structuredContent, with the same JSON as a text block.

object · all fields required
attributesmap of string → string | number | boolean

The subscriber’s attributes: a map of string, number or boolean values.
confirmed_atstring · date-time | null

When the subscriber confirmed a double opt-in; null otherwise.
created_atstring · date-time
emailstring · email
idstring · uuid
list_idstring · uuid

The list the subscriber is on.
project_idstring · uuid

The subscriber’s project.
soft_bounce_streakinteger · uint32

Soft bounces in a row; reset by a delivery (P4+).

≥ 0
sourcestring

How the subscriber was added: api, import or confirm.
statusstring

pending, active, unsubscribed, bounced or complained.
unsubscribed_atstring · date-time | null

When the subscriber unsubscribed; null otherwise.
updated_atstring · date-time

The latest change: creation, an attribute merge.

Errors

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors

HTTP API

The same operation over HTTP: POST /api/v1/projects/{project_id}/subscribers/{subscriber_id}/unsubscribe