Create and schedule campaign

Creates a campaign for the selected location using a chosen template and channel, and either sends it now or schedules it with scheduled_at.

list decides who receives it: All contacts, Not contacted, or the name of a tag to reach only the contacts carrying it - that is how you segment. An unknown tag name is rejected rather than quietly falling back to everyone. Create tags with POST /tags and assign them when you create contacts.

A campaign with no recipients is refused, and the plan's message allowance applies.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Business id path parameter (required).

string
required

Location id path parameter (required).

Body Params
string
required

Name of the campaign

string
required

Identifier of the template to be used in the campaign

string
required

Who the campaign goes to. Use All contacts or Not contacted for the two automatic groups, or the name of a tag to reach only the contacts carrying it. Tag names are matched case-insensitively, and an unknown name is rejected instead of quietly falling back to everyone.

string
enum
required

Channel of the campaign

Allowed:

Scheduled time for the campaign

boolean
Defaults to false

Whether reminder scheduling is enabled

Responses

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