CampaignsTrigger campaign
Campaigns

Trigger campaign

Manually trigger a campaign for specific users.

curl -X POST "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns/example_string/trigger" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "user_ids": [
    "example_string"
  ],
  "filters": {},
  "data": {}
}'
{
  "success": true,
  "recipients_count": 10
}
POST
/workspaces/{workspaceId}/campaigns/{campaignId}/trigger
POST
Security Scheme
Bearer Token
Bearer Tokenstring
Required

Your Flameup API key (passed as Bearer token)

Your Flameup API key (passed as Bearer token)
Content-Typestring
Required

The media type of the request body

Options: application/json
Request Preview
Response

Response will appear here after sending the request

Authentication

BearerAuth
header
Authorizationstring
Required

Bearer token. Your Flameup API key (passed as Bearer token)

Path Parameters

Responses

successboolean
recipients_countinteger
Was this page helpful?
Built with Documentation.AI

Last updated today