Create & Launch an API Campaign

This guide walks you through creating an API Campaign in Onbbits and getting the request details you need to trigger it from your own system, such as an ERP or another software platform.

Step 1: Choose Your Campaign Type

Go to Campaigns and click Add Campaign.
On the Select Campaign Type screen, choose API Campaign.

Step 2: Add Campaign Details

Enter a Campaign Name. It needs to be unique, so avoid reusing a name from a previous campaign.
Add a Description if you’d like (this is optional).

Step 3: Select a Template

Choose a template from the Select Template dropdown.

Unlike a Broadcast Campaign, you won’t fill in template parameters here. Those get passed in later, through your own API request. There’s also no audience selection step, since each message is sent to a destination number through your API request rather than a filtered list.

Step 4: Review and Create

Review the Campaign Info summary.
Click Create Campaign.

Step 5: Get Your API Request Details

Once your API Campaign is created, you’ll need its request details to connect it to your own system.

Find your API Campaign and click Test Campaign.
Review the API Request Configuration panel. It shows the full JSON payload.
Click Copy cURL or Copy JSON to grab the request for your system.
Click the Test Campaign to send a test message to confirm everything works.

Your API Campaign appears on the Campaigns dashboard right away, ready for you to test and connect using the API Request Configuration.

What Is a Campaign?

Understanding Campaign Analytics

Create & Launch a Broadcast Campaign

Schedule a Campaign

Retarget Campaigns

Still need help?

Our support team is ready to assist you.

Terms

On this page

Search documents