Skip to content
View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

POST Campaign Tag Actions​

POST
/campaigns-pro/{id}/tag-actions

Add or remove tags from subscribers based on campaign activity (email opened, not opened, or link clicked). Only works on archived campaigns. Processes subscribers in paginated batches (default 50 per page) to handle large campaigns.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

Enforced by CampaignPolicy::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 campaign ID. Campaign must be in 'archived' status.

Type
integer
Required

Request Body​

application/json
JSON
{
"action_type": "string",
"tags": [
0
],
"activity_type": "string",
"processing_page": 0,
"link_ids": [
0
]
}

Responses​

Tag action processed for the current batch.

application/json
JSON
{
"processed_page": 0,
"processed_contacts": 0,
"has_more": true,
"total_count": 0,
"subscriber_ids": [
0
]
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI