Skip to main content
POST
/
api
/
v1
/
subscribers
Create Subscriber
curl --request POST \
  --url https://api.sequenzy.com/api/v1/subscribers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "lists": [
    "<string>"
  ],
  "customAttributes": {},
  "enrollInSequences": true,
  "duplicateStrategy": "<string>"
}
'
{
  "success": true,
  "subscriber": {
    "id": "sub_abc123",
    "email": "user@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "tags": ["lead", "saas.monthly"],
    "createdAt": "2024-01-15T10:30:00Z",
    "created": true,
    "updated": false,
    "skipped": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a new subscriber or handle existing ones based on the duplicateStrategy parameter.

​
Request Body

​
email
string
required
Subscriber email address
​
firstName
string
First name
​
lastName
string
Last name
​
status
string
default:"active"
Status: active or unsubscribed
​
tags
string[]
Array of tag names to assign
​
lists
string[]
Array of list IDs to add the subscriber to. If omitted, the subscriber will be added to all lists. If set to an empty array [], the subscriber will not be added to any lists.
​
customAttributes
object
Custom key-value attributes
​
enrollInSequences
boolean
default:"true"
Whether to enroll the subscriber in matching sequences. Defaults to true.
​
duplicateStrategy
string
default:"skip"
How to handle existing subscribers:
  • skip - Don’t update existing subscribers (default)
  • merge - Only fill in missing fields, never overwrite existing values
  • overwrite - Replace all fields (but never reactivate unsubscribed users)
curl -X POST "https://api.sequenzy.com/api/v1/subscribers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "tags": ["lead", "saas.monthly"],
    "lists": ["list_abc123"],
    "enrollInSequences": true,
    "duplicateStrategy": "skip"
  }'

​
Responses

{
  "success": true,
  "subscriber": {
    "id": "sub_abc123",
    "email": "user@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "tags": ["lead", "saas.monthly"],
    "createdAt": "2024-01-15T10:30:00Z",
    "created": true,
    "updated": false,
    "skipped": false
  }
}