Subscribers

Update subscriber

Updates a subscriber's first name, last name, status, tags, or custom attributes. Setting status to unsubscribed performs the full unsubscribe workflow, including list unsubscription and sequence cancellation.

patch/subscribers/{email}

Path parameters

emailstring required

URL-encoded email address

Request body

emailstring email

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

externalIdstring

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

firstNamestring

lastNamestring

status'active' | 'unsubscribed' | 'bounced'

Setting unsubscribed performs a full global unsubscribe.

tagsstring[]

customAttributesobject

Example request

{
  "firstName": "Jane",
  "lastName": "Smith",
  "tags": [
    "premium",
    "vip"
  ]
}

Response

Subscriber updated

successboolean

Example response

{
  "success": true,
  "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"
    }
  }
}