Audiences

Update a subscriber

Update display name or merge fields. To unsubscribe, use the unsubscribe endpoint.

patch/audiences/{id}/subscribers/{subscriber_id}

Request

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

display_namestring nullable
merge_fieldsMergeFields

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

Response

Updated subscriber.

object'subscriber' required
idstring required
audience_idstring required
email_addressstring email required
display_namestring nullable required
status'subscribed' | 'pending' | 'unsubscribed' | 'bounced' | 'complained' | 'suppressed' | 'transactional_only' | 'dormant' required

dormant: stopped reading and did not answer the last-chance email of list cleanup. Newsletters skip dormant subscribers until they sign up again or click the keep link; resubscribe brings one back.

merge_fieldsMergeFields required

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

consent_sourcestring nullable 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.