POST/api/v1/projects/{project_id}/subscribers/{subscriber_id}/reactivate
reactivate_subscriber
Takes a bounced or complained subscriber back to active.
- Call it
- only when the address is known to work again and to want the mail.
- Needs
- an admin key with
project_id(a project key isforbiddenwhatever its scopes), areason, and a live list; suppressions stay (remove ahard_bounceorcomplaintone withremove_suppression). - Returns
- the subscriber after the call, the same as
POST /api/v1/projects/{project_id}/subscribers/{subscriber_id}/reactivate.
Arguments
- object
-
reasonstringrequiredWhy the address may get mail again; 1 to 256 characters, kept in the event
subscriber.reactivated.example
the mailbox works again (ticket 4711) -
subscriber_idstring · uuidrequiredThe subscriber’s id.
-
project_idstring · uuid | nullThe subscriber’s project; an admin key must pass it (only an admin key may reactivate).
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 | booleanThe subscriber’s attributes: a map of string, number or boolean values.
-
confirmed_atstring · date-time | nullWhen the subscriber confirmed a double opt-in;
nullotherwise. -
created_atstring · date-time -
emailstring · email -
idstring · uuid -
list_idstring · uuidThe list the subscriber is on.
-
project_idstring · uuidThe subscriber’s project.
-
soft_bounce_streakinteger · uint32Soft bounces in a row; reset by a delivery (P4+).
≥ 0
-
sourcestringHow the subscriber was added:
api,importorconfirm. -
statusstringpending,active,unsubscribed,bouncedorcomplained. -
unsubscribed_atstring · date-time | nullWhen the subscriber unsubscribed;
nullotherwise. -
updated_atstring · date-timeThe 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}/reactivate