Audiences

Add subscribers in bulk

Add up to 1000 subscribers in one call (single opt-in). Returns a per-row outcome for each address, in input order. Net-new admissions are all-or-nothing against the monthly ingest quota: if the remaining quota cannot admit every net-new address in the batch, they are all returned as skipped_quota.

post/audiences/{id}/subscribers/batch

Request

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

Response

Per-row outcomes, in input order.

Changes

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