API triggered campaigns

Template campaigns executed by the external API

Template campaigns can be created using the UI on the platform, but triggered later via the Campaign Execute API.

You can find API Triggered Campaigns on the Create Campaign page, build them like any regular campaign.

Any available outbound channel may be triggered by an API execution and multiple channels can be used in your template if required.

These message are typically transactional with a mixture of fixed content in the template and variables sent via API. Use the double curly brace syntax to add variables, eg. {{variable_name}}. Further information can be found in the guide on dynamic content.

Once the template is configured with channel, content, variables, etc., put the campaign live with the Review & Launch button like any other campaign. The campaign will be listed in Existing campaigns > Live Campaigns. Here you will find the campaign ID, which is needed to trigger the campaign using the Campaign Execute API.

Updated 3 months ago


API triggered campaigns


Template campaigns executed by the external API

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.