Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

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

Idempotency-KeyMCP tool: reactivate_subscriber operationId reactivate_subscriber

Reactivate a bounced or complained subscriber

Takes a bounced or complained subscriber back to active, with a reason. Only an admin key may: a project key gets 403 whatever its scopes. Suppressions are not touched (remove a hard_bounce or complaint one with DELETE .../suppressions/{email}). An active subscriber stays as it is.

Parameters

NameInTypeDescription
project_idrequired path string · uuid The project’s id
subscriber_idrequired path string · uuid The subscriber’s id
Idempotency-Key header string

1–128 characters · pattern ^[!-~]{1,128}$

A key of the client’s choosing, one per request it means to send once (a UUID will do). A repeat with the same key and the same body within 24 h creates nothing again and gets the first answer, marked Idempotent-Replayed: true. The key belongs to the API key that sent it. Only a 2xx answer is kept: after any other answer the key is free again.

Request body

application/json · required

  • ReactivateRequest object · all fields required
  • reasonstring

    1 to 256 characters. Recorded in the event subscriber.reactivated.

    example the mailbox works again (ticket 4711)

Responses

200

The subscriber after the call

HeaderTypeDescription
Idempotent-Replayedstring · enumtrue when the answer is a replay of an earlier request with the same Idempotency-Key; absent otherwise.
  • Subscriber object · all fields required
  • attributesobject

    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

    example ann@example.com

  • idstring · uuid

    example 01900000-0000-7000-8000-000000000001

  • list_idstring · uuid

    The list the subscriber is on.

  • project_idstring · uuid

    The subscriber’s project.

  • soft_bounce_streakinteger · int32

    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.

    example active

  • unsubscribed_atstring · date-time | null

    When the subscriber unsubscribed; null otherwise.

  • updated_atstring · date-time

    The latest change: creation, an attribute merge, a status change.

403

A project key, whatever its scopes (forbidden)

Problem (application/problem+json)

404

No such subscriber or project, or another project’s (not_found)

Problem (application/problem+json)

409

The project or list is deleted, or the subscriber is pending or unsubscribed (conflict); or a request with the same Idempotency-Key has not answered yet (idempotency_key_in_progress)

Problem (application/problem+json)

422

No or an invalid reason (validation_failed); or the Idempotency-Key was used in the last 24 h for another request (idempotency_key_reused), or is not 1 to 128 visible ASCII characters (validation_failed, field Idempotency-Key)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

HeaderTypeDescription
Retry-AfterintegerSeconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)