DocumentationUser GuideDeveloper GuideAPITechnology Partners
For Developers
indigitall.comChat with us

Create campaign

post
https://api.indigitall.com/v2/chat//campaign

Create a new chat campaign for a given application

Path Params
integer
required

Application's ID

Body Params
boolean
required

Indicates whether a specific campaign is active or not

string
required

Campaign title

string
enum
required
Defaults to proactive

Use a proactive sendType when you want to send a message campaign to users without them having sent a message beforehand. A campaign with proactive sendType can be sent through all sending endpoints and integrations.

Use a reactive sendType when you want to send a message campaign to users after they have sent a message beforehand. The reactive sendType only allows sending a campaign through an integration (e.g., AutoReply way) but not through the sending endpoints.

In both cases, there may be limitations on certain message formats depending on the channel or channels through which the campaign will be sent.

Allowed:
channelTypes
array of objects
required
length ≥ 1

List of channel types associated with the campaign. The channel types are used to determine the channels that will be used to send campaign messages.

At least one channel type is required.

channelTypes*
messageContent
array of objects
required
length between 1 and 5

List of message contents associated with the campaign. This parameter is used to determine the content from the messages that will be sent to users through the campaign.

At least one message is required and a maximum of 5 messages can be defined.

messageContent*
string
required

Text message

boolean
Defaults to false

Indicates whether a specific campaign belongs to Customer Journey service or not. These campaigns cannot be edited or deleted.

This parameter cannot be changed once the campaign is created.

Responses

Updated 18 days ago

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