broadcastCampaignToList
Trigger email campaigns to specific contact lists or segments using a single API request. Personalize content with dynamic variables and ensure safe retries with unique idempotency keys.
Instructions
The broadcast campaign API allows the user to trigger campaigns to the entire contact list using a single API request.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | Yes | Campaign id of the campaign to be triggered | |
| campaign_data | No | Optional set of personalization parameters for the campaign. Each key represents a variable (e.g., "first_name") to be used in the email template. If a key is missing, the backend will fetch values from contact properties or default to an empty string. | |
| idempotencyKey | No | Optional unique key to allow retries of the same campaign within 24 hours. Allows safe resending. For example: "2024-09-05T17:00:00Z". | |
| listId | Yes | Id of the contact list or segment for which the campaign should be triggered. | |
| subject | No | Optional subject line of the campaign. This will appear as the subject of the email sent to recipients. |