FluentCRM Developers

Appearance

View as Markdown

POST Add Sequence Subscribers​

POST
/sequences/{id}/subscribers

Subscribe contacts to an email sequence. Supports filtering by lists, tags, dynamic segments, or advanced filters. Subscribers already enrolled in the sequence are automatically excluded. Processes subscribers in batches (default 200 per request) -- use pagination for large sets. Requires FluentCampaign Pro.

Required capability: fcrm_manage_emails

Enforced by SequencePolicy::verifyRequest(), the policy default for this route group.

Requires: FluentCampaign Pro. Without it the route does not exist.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The sequence ID.

Type
integer
Required

Request Body​

application/json
JSON
{
"subscribers": {
"lists": [
0
],
"tags": [
0
]
},
"excludedSubscribers": {
"lists": [
0
],
"tags": [
0
]
},
"sending_filter": "list_tag",
"dynamic_segment": {
},
"advanced_filters": [
{
}
],
"page": 1
}

Responses​

Subscribers added to the sequence. Check remaining to determine if more batches need processing.

application/json
JSON
{
"total": 0,
"remaining": 0,
"next_page": 0,
"page_total": 0,
"in_total": 0
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI