Skip to main content
PATCH
/
api
/
v1
/
subscribers
/
{email}
Update Subscriber
curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/subscribers/{email} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "email": "<string>",
  "externalId": "<string>",
  "lastName": "<string>",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "customAttributes": {}
}
'
{
  "success": true,
  "subscriber": {
    "id": "sub_abc123",
    "email": "user@sequenzy.com",
    "externalId": "user_123",
    "firstName": "Jane",
    "lastName": "Doe",
    "status": "active",
    "tags": ["customer", "vip"],
    "customAttributes": { "plan": "pro" },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-16T14:20:00Z"
  }
}
Update a subscriber’s first name, last name, status, tags, or custom attributes. When you set status to unsubscribed, Sequenzy runs the full unsubscribe workflow: it unsubscribes the contact from all lists and cancels their active sequence enrollments. You can also update by external ID with PATCH /api/v1/subscribers/external?externalId={externalId}.

​
Path Parameters

​
email
string
required
Subscriber email (URL encoded)

​
Query Parameters

​
externalId
string
External ID to use with /subscribers/external. Use this route for IDs that contain /.

​
Request Body

​
firstName
string
First name
​
email
string
New delivery email address. This is most useful on the external ID route.
​
externalId
string
New customer-owned external ID. The update fails with 409 if another subscriber owns it.
​
lastName
string
Last name
​
status
string
Status: active, unsubscribed, or bounced. Setting active resubscribes the contact. Setting unsubscribed performs a full global unsubscribe.
​
tags
string[]
Replace all tags with this array
​
customAttributes
object
Replace custom attributes
curl -X PATCH "https://api.sequenzy.com/api/v1/subscribers/user%40sequenzy.com" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "status": "active",
    "tags": ["customer", "vip"]
  }'

curl -X PATCH "https://api.sequenzy.com/api/v1/subscribers/external?externalId=user_123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "new-user@example.com",
    "lastName": "Updated"
  }'

​
Responses

{
  "success": true,
  "subscriber": {
    "id": "sub_abc123",
    "email": "user@sequenzy.com",
    "externalId": "user_123",
    "firstName": "Jane",
    "lastName": "Doe",
    "status": "active",
    "tags": ["customer", "vip"],
    "customAttributes": { "plan": "pro" },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-16T14:20:00Z"
  }
}