Skip to main content
POST
Create Campaign with WhatsApp Touchpoint

Authorizations

string
required
Enter your ContactSwing JWT Bearer token.

Request Body

string
required
Campaign display name.
string
Campaign type. (e.g. None)
string
Company plan ID.
string
Workspace ID.
string
The business goal of the campaign.
object
required
The touchpoint object.
string
required
The name of the touchpoint.
string
required
The type of the touchpoint. e.g. WHATSAPP.
boolean
Whether consultants are involved in execution.
string
required
The status of the touchpoint. e.g. scheduled.
string
required
ISO 8601 scheduled date for the touchpoint.
integer
required
The ID of the assistant to be used.
string
URL for any attachment sent with WhatsApp.
object
required
Additional settings for WhatsApp touchpoint.
string[]
required
Array of days when the campaign will run. e.g. ["mon", "tue", "wed"]
integer
required
Start hour for campaign execution.
integer
required
End hour for campaign execution.
integer
required
Delay between executions (in minutes).
string
required
Timezone for campaign execution. e.g. Asia/Kolkata.
boolean
Whether to bypass suppression rules.
string[]
required
WhatsApp numbers from which the message will be sent.
array
required
Array of customer details.
string
required
The customer’s ID.
string
required
The customer’s WhatsApp number.
object
required
WhatsApp template & message content.
string
Template name.
string
Language code. e.g. en.
object
Parameters for body section of template.
boolean
Whether parameters are static.
array
Body template parameters.
object
Header template parameters.
boolean
Whether parameters are static.
array
Header template parameters.
object
Button template parameters.
boolean
Whether parameters are static.
array
Button template parameters.
string
Plain text WhatsApp message body (if not using template).
array
Dynamic variables used inside campaign.

Response

201 Created – Campaign created successfully
string
Request context ID
object
string
Campaign ID
string
Campaign name
string
Campaign status
400 Bad Request – Invalid input