Tags v3 endpoints
Tags allow you to organize and segment your subscribers based on their interests, behaviors, or characteristics. They’re essential for targeted email campaigns and subscriber management.
Returns a list of tags for your account.
GET /v3/tags
Your account API key
Create one or multiple tags for your account.
POST /v3/tags
Your API key
A JSON object or an array of JSON objects that includes the tag name. Each object should contain:
name
(required): The name of the tagTags are handled as subscriptions. Subscribe an email address to a tag to have that tag applied to the subscriber with that email address.
POST /v3/tags/#{tag_id}/subscribe
Your API secret key
The ID of the tag you want to apply
Subscriber email address
Subscriber first name
Object of key/value pairs for custom field(s). The custom field(s) must exist before you can use it here.
Array of tag ids to subscribe to
Array of sequence ids to subscribe to. You should add the subscriber to the sequence directly.
Array of form ids to subscribe to. You should add the subscriber to the form directly.
Subscriber first name. You should prefer using first_name
listed above.
Remove a specific tag from a subscriber by subscriber ID.
DELETE /v3/subscribers/#{subscriber_id}/tags/#{tag_id}
Your API secret key
The ID of the subscriber
The ID of the tag to remove
Remove a specific tag from a subscriber by email address.
POST /v3/tags/#{tag_id}/unsubscribe
Your API secret key
The ID of the tag to remove
Subscriber email address
List subscriptions to a tag including subscriber data.
GET /v3/tags/#{tag_id}/subscriptions
Your API secret key
The ID of the tag you want to retrieve subscriptions for
Sort order for results (asc
or desc
). asc
to list subscribers added oldest to newest, desc
to list subscribers added newest to oldest. Default is asc
.
Filter by subscriber state (active
or cancelled
). Receive only active subscribers or cancelled subscribers.
The page of results being requested. Default value is 1
. Each page of results will contain up to 50 subscriptions.
Tags v3 endpoints
Tags allow you to organize and segment your subscribers based on their interests, behaviors, or characteristics. They’re essential for targeted email campaigns and subscriber management.
Returns a list of tags for your account.
GET /v3/tags
Your account API key
Create one or multiple tags for your account.
POST /v3/tags
Your API key
A JSON object or an array of JSON objects that includes the tag name. Each object should contain:
name
(required): The name of the tagTags are handled as subscriptions. Subscribe an email address to a tag to have that tag applied to the subscriber with that email address.
POST /v3/tags/#{tag_id}/subscribe
Your API secret key
The ID of the tag you want to apply
Subscriber email address
Subscriber first name
Object of key/value pairs for custom field(s). The custom field(s) must exist before you can use it here.
Array of tag ids to subscribe to
Array of sequence ids to subscribe to. You should add the subscriber to the sequence directly.
Array of form ids to subscribe to. You should add the subscriber to the form directly.
Subscriber first name. You should prefer using first_name
listed above.
Remove a specific tag from a subscriber by subscriber ID.
DELETE /v3/subscribers/#{subscriber_id}/tags/#{tag_id}
Your API secret key
The ID of the subscriber
The ID of the tag to remove
Remove a specific tag from a subscriber by email address.
POST /v3/tags/#{tag_id}/unsubscribe
Your API secret key
The ID of the tag to remove
Subscriber email address
List subscriptions to a tag including subscriber data.
GET /v3/tags/#{tag_id}/subscriptions
Your API secret key
The ID of the tag you want to retrieve subscriptions for
Sort order for results (asc
or desc
). asc
to list subscribers added oldest to newest, desc
to list subscribers added newest to oldest. Default is asc
.
Filter by subscriber state (active
or cancelled
). Receive only active subscribers or cancelled subscribers.
The page of results being requested. Default value is 1
. Each page of results will contain up to 50 subscriptions.