Audiences

Remove a welcome email

Remove an email from the sequence. Readers waiting for it go on to the next one. A running sequence keeps at least one email.

delete/audiences/{id}/welcome-sequence/steps/{stepId}

Request

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

Response

The removed welcome email.

object'welcome_step' required
idstring required
deletedtrue required

Changes

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