Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

Subscribers HTTP API

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

resubscribe_subscriber

Subscribes an unsubscribed subscriber again, with fresh consent: active, or pending on a list with double opt-in; the suppression its unsubscribe left is removed.

Call it
when the person asked to get the list’s mail again.
Needs
consent_source (where the consent came from), a live list, no other suppression of the list (remove the project’s or a manual one first, remove_suppression), and an admin key with project_id or a project key with scope write (its own project; the argument is ignored).
Returns
the subscriber after the call, the same as POST /api/v1/projects/{project_id}/subscribers/{subscriber_id}/resubscribe.

Arguments

  • object
  • consent_sourcestringrequired

    Where the new consent came from (a form, a support ticket); 1 to 256 characters, kept in the event subscriber.resubscribed.

    example signup form, 2026-11-07

  • 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.

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}/resubscribe