Skip to content

API campaigns

This reference article covers how to generate a campaign_id to include in your API calls and how to configure that campaign.

Create a new campaign

Navigate to the Campaigns page in your company Braze account and click Create Campaign, then select API Campaigns. Now, you can move on to configuring your API campaign.

Configure your campaign

To configure your campaign, perform the following steps:

  1. Add a descriptive title so you can find the results on our campaigns page after you’ve sent your messages.
  2. Click Add Message and add the messages types which will be included in your API campaign. This will create a Message Variation ID, which will serve as your campaign_id.

    After you save your API campaign, you must include the generated campaign_id fields with your API request where noted in the Send Messages Endpoints.

  3. Optionally, You can add a conversion event to track user conversions on a specific action or campaign goal.
  4. Click Save Campaign and you’re set to begin your API campaign!
New Stuff!