Audiences

Get the welcome sequence

Fetch an audience's welcome sequence: whether it runs, its emails in order with their waits and send counts, and how many readers are in it.

get/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

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.

Response

The welcome sequence. An audience without one returns enabled false and no steps.

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.