API Reference

Create a campaign.

post
https://localhost/v4/campaigns

Create a campaign.

Required scope: write_campaigns.

Body Params

Create campaign params

boolean
Defaults to false

Should this message be sent to subscribers who have an active conversation in the Inbox?

locations
array of uuids
required

List of location UIDs

locations*
string

The message sent to subscribers

string
required

The name of the campaign

boolean
Defaults to false

Should this message be sent to subscribers who have received a campaign in the past 5 days?

string
enum
required

The current campaign status

Responses

Callback

Updated 24 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago