Audiences

Add a subscriber

Add one subscriber (single opt-in). Returns a per-row outcome; it does not error for a suppressed or invalid address. Re-adding an existing subscriber merges: a provided display_name replaces the stored one (absent keeps it), merge_fields keys you send are merged into the stored object, and consent is re-attested. Use PATCH to replace fields wholesale.

post/audiences/{id}/subscribers

Request

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

Request body

email_addressstring email required
display_namestring nullable
merge_fieldsMergeFields

Arbitrary string/number/boolean/null values keyed by field name. Max 50 keys.

consent_sourcestring nullable
consent_ipstring nullable

Response

Per-row outcome for the address.

email_addressstring email required
outcome'created' | 'updated' | 'skipped_not_mailable' | 'skipped_invalid' | 'skipped_cap' | 'skipped_quota' required

Changes

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