Sign in
Subscribers

Update subscriber by external ID

Updates a subscriber's email, external ID, first name, last name, status, tags, or custom attributes.

patch/subscribers/external

Query parameters

externalIdstring required

External ID. Query form supports IDs containing slashes.

Request body

emailstring email

New delivery email. Fails with 409 if another subscriber owns it.

externalIdstring

New external ID. Fails with 409 if another subscriber owns it.

firstNamestring
lastNamestring
status'active' | 'unsubscribed' | 'bounced'

Setting unsubscribed performs the unsubscribe workflow.

tagsstring[]
customAttributesobject

Response

Subscriber updated

successboolean

Example response

{
  "subscriber": {
    "id": "sub_abc123",
    "email": "user@example.com",
    "externalId": "user_123",
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "emailProvider": "gmail",
    "tags": [
      "premium",
      "newsletter"
    ],
    "customAttributes": {
      "plan": "pro",
      "signupSource": "website"
    }
  }
}

Changes