Audiences

Add a welcome email

Add an email to the end of the audience's welcome sequence. wait_minutes counts from the previous email, or from the subscribe for the first email.

post/audiences/{id}/welcome-sequence/steps

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/audiences/{id}/welcome-sequence/steps
  • 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

subjectstring required
preview_textstring nullable
content_markdownstring

The body as Markdown, converted to blocks on the server. Send blocks or content_markdown, not both.

wait_minutesinteger
sender_identity_idstring

Defaults to the organization's default sender identity.

track_engagementboolean
add_utm_tagsboolean
styling_mode'styled' | 'plain'

Response

The new welcome email.

object'welcome_step' required
idstring required
audience_idstring nullable required
positioninteger required

Order in the sequence. Positions only grow; gaps are normal.

wait_minutesinteger required

Minutes after the previous email (or after the subscribe, for the first email) before this one is sent.

sender_identity_idstring nullable required
subjectstring nullable required
preview_textstring nullable required
track_engagementboolean required
add_utm_tagsboolean required
styling_mode'styled' | 'plain' required
sent_countinteger required
delivered_countinteger required
bounced_countinteger required
complained_countinteger required
created_atstring date-time required
updated_atstring date-time required

Changes

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