Audiences

Turn the welcome sequence on or off

Turn the sequence on or off. While it is on, readers who subscribe through a signup form or the API (or confirm, with double opt-in) get its emails through the newsletter send path: the same footer, unsubscribe headers, suppressions and monthly limit as newsletters. At most 100 welcome emails per audience go out in any ten minutes; the rest wait, and the owner gets an email.

patch/audiences/{id}/welcome-sequence

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/audiences/{id}/welcome-sequence
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

Idempotency-Keystring

Unique key for idempotent requests. Printable ASCII, 1-255 characters. The response is cached for 24 hours. A message send also derives the message ID from the key, so after the cache expires a retry on the same endpoint returns the message already sent, without comparing the body, for as long as that message exists.

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

enabledboolean required

Turn the sequence on or off. Turning it on needs at least one email with a subject and a body, and resumes a paused sequence.

Response

The updated welcome sequence.

object'welcome_sequence' required
audience_idstring required
enabledboolean required

Readers who subscribe through a signup form or the API while this is true start the sequence. With double opt-in, they start when they confirm.

pausedboolean required

True when bounces or complaints passed the pause limits. Sends wait until the sequence is enabled again.

pause_reasonstring nullable required
active_readersinteger required
completed_readersinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.