Update Subscriber

PATCH

api

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>",
  "timezone": "<string>",
  "phone": "<string>",
  "phoneCountry": "<string>",
  "smsConsent": true,
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "customAttributes": {},
  "customAttributesStrategy": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/subscribers/{email}"

payload = {
    "firstName": "<string>",
    "email": "<string>",
    "externalId": "<string>",
    "lastName": "<string>",
    "timezone": "<string>",
    "phone": "<string>",
    "phoneCountry": "<string>",
    "smsConsent": True,
    "status": "<string>",
    "tags": ["<string>"],
    "customAttributes": {},
    "customAttributesStrategy": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    email: '<string>',
    externalId: '<string>',
    lastName: '<string>',
    timezone: '<string>',
    phone: '<string>',
    phoneCountry: '<string>',
    smsConsent: true,
    status: '<string>',
    tags: ['<string>'],
    customAttributes: {},
    customAttributesStrategy: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/subscribers/{email}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/subscribers/{email}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'email' => '<string>',
    'externalId' => '<string>',
    'lastName' => '<string>',
    'timezone' => '<string>',
    'phone' => '<string>',
    'phoneCountry' => '<string>',
    'smsConsent' => true,
    'status' => '<string>',
    'tags' => [
        '<string>'
    ],
    'customAttributes' => [
        
    ],
    'customAttributesStrategy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/subscribers/{email}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"phoneCountry\": \"<string>\",\n  \"smsConsent\": true,\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"customAttributes\": {},\n  \"customAttributesStrategy\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sequenzy.com/api/v1/subscribers/{email}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"phoneCountry\": \"<string>\",\n  \"smsConsent\": true,\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"customAttributes\": {},\n  \"customAttributesStrategy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/subscribers/{email}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"phoneCountry\": \"<string>\",\n  \"smsConsent\": true,\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"customAttributes\": {},\n  \"customAttributesStrategy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "success": false,
  "error": "externalId is required"
}

{
  "success": false,
  "error": "lastName must be at most 255 characters"
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid phone number. Provide a valid phone in E.164 format, e.g. +15551234567, or US national format."
  }
}

{
  "type": "validation",
  "on": "body",
  "property": "/status",
  "message": "Expected union value"
}

{
  "success": false,
  "error": "Subscriber not found"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Subscriber identity conflict: target email belongs to a different subscriber."
}

{
  "success": false,
  "error": "Internal server error"
}

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

string

required

Subscriber email (URL encoded)

Query Parameters

string

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

Request Body

string

First name, up to 255 Unicode characters. Omit to keep unchanged, or send "" to clear. null is not accepted.

string

New delivery email address. This is most useful on the external ID route.

string

New customer-owned external ID. The update fails with 409 if another subscriber owns it.

string

Last name, with the same limit and clear behavior as firstName.

string

IANA timezone identifier such as America/New_York, stored as a native profile field. Enables recipient-local campaign delivery. An invalid identifier returns 400 VALIDATION_ERROR; null clears the stored value.

string

Phone number in E.164 format (+15551234567) or national format. Stored normalized to E.164 on the native phone field, not as a custom attribute. An invalid phone returns 400 VALIDATION_ERROR. Setting a phone does NOT subscribe the contact to SMS - use smsConsent for that, and note that changing the number resets SMS consent unless smsConsent is sent in the same request. null or "" clears the phone, except on a phone-only (SMS) contact

clearing the only identity it has returns 400 VALIDATION_ERROR.

string

ISO 3166-1 alpha-2 country used to read a national-format phone, such as IT or US. Defaults to US. This is a parsing hint only: the stored phoneCountry always comes from the parsed number, so it can never disagree with the phone it belongs to. Sending it without phone returns 400 VALIDATION_ERROR.

SMS marketing consent. true sets the subscriber’s SMS status to subscribed with consent source api - only send true when you have express written consent. false sets it to unsubscribed. When omitted, SMS status stays unchanged unless phone changes, which resets consent because it belonged to the old number. Consent is never inferred from phone presence. See SMS & MMS for the full consent model.

string

Status: active, unsubscribed, or bounced. Setting active resubscribes the contact. Setting unsubscribed performs a full global unsubscribe.

string[]

Replace all tags with this array

object

Custom attributes to update. By default this replaces the existing public custom-attribute map.

string

default:"replace"

How to apply customAttributes: replace replaces the existing public custom-attribute map, while merge overwrites only the provided keys and retains unspecified existing keys.

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",
    "phone": "+15551234567",
    "smsConsent": true,
    "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",
    "customAttributesStrategy": "merge",
    "customAttributes": {
      "plan": "pro"
    }
  }'

With customAttributesStrategy: "merge", a subscriber whose existing customAttributes are {"arr":["1","2"],"letter":"X","val":true,"other":"abc"} and whose PATCH payload is {"customAttributesStrategy":"merge","customAttributes":{"arr":["3"],"letter":"Z","number":3}} ends with {"arr":["3"],"letter":"Z","number":3,"val":true,"other":"abc"}. Names longer than 255 Unicode characters return 400 with a field-specific error before any identity, status, tag, or attribute changes. Correct the name before retrying. For compatibility, excess trailing ASCII spaces remain accepted and are truncated by the database; names are otherwise never truncated.

Responses

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

{
  "success": false,
  "error": "externalId is required"
}

{
  "success": false,
  "error": "lastName must be at most 255 characters"
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid phone number. Provide a valid phone in E.164 format, e.g. +15551234567, or US national format."
  }
}

{
  "type": "validation",
  "on": "body",
  "property": "/status",
  "message": "Expected union value"
}

{
  "success": false,
  "error": "Subscriber not found"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Subscriber identity conflict: target email belongs to a different subscriber."
}

{
  "success": false,
  "error": "Internal server error"
}

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>",
  "timezone": "<string>",
  "phone": "<string>",
  "phoneCountry": "<string>",
  "smsConsent": true,
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "customAttributes": {},
  "customAttributesStrategy": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/subscribers/{email}"

payload = {
    "firstName": "<string>",
    "email": "<string>",
    "externalId": "<string>",
    "lastName": "<string>",
    "timezone": "<string>",
    "phone": "<string>",
    "phoneCountry": "<string>",
    "smsConsent": True,
    "status": "<string>",
    "tags": ["<string>"],
    "customAttributes": {},
    "customAttributesStrategy": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    email: '<string>',
    externalId: '<string>',
    lastName: '<string>',
    timezone: '<string>',
    phone: '<string>',
    phoneCountry: '<string>',
    smsConsent: true,
    status: '<string>',
    tags: ['<string>'],
    customAttributes: {},
    customAttributesStrategy: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/subscribers/{email}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/subscribers/{email}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'email' => '<string>',
    'externalId' => '<string>',
    'lastName' => '<string>',
    'timezone' => '<string>',
    'phone' => '<string>',
    'phoneCountry' => '<string>',
    'smsConsent' => true,
    'status' => '<string>',
    'tags' => [
        '<string>'
    ],
    'customAttributes' => [
        
    ],
    'customAttributesStrategy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/subscribers/{email}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"phoneCountry\": \"<string>\",\n  \"smsConsent\": true,\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"customAttributes\": {},\n  \"customAttributesStrategy\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sequenzy.com/api/v1/subscribers/{email}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"phoneCountry\": \"<string>\",\n  \"smsConsent\": true,\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"customAttributes\": {},\n  \"customAttributesStrategy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/subscribers/{email}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"phoneCountry\": \"<string>\",\n  \"smsConsent\": true,\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"customAttributes\": {},\n  \"customAttributesStrategy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "success": false,
  "error": "externalId is required"
}

{
  "success": false,
  "error": "lastName must be at most 255 characters"
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid phone number. Provide a valid phone in E.164 format, e.g. +15551234567, or US national format."
  }
}

{
  "type": "validation",
  "on": "body",
  "property": "/status",
  "message": "Expected union value"
}

{
  "success": false,
  "error": "Subscriber not found"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Subscriber identity conflict: target email belongs to a different subscriber."
}

{
  "success": false,
  "error": "Internal server error"
}

​Path Parameters

​Query Parameters

​Request Body

​Responses

Path Parameters

Query Parameters

Request Body

Responses