Creates campaign

post

https://api.indigitall.com/v2/sms/campaign

Creates a new campaign with support for different message formats:

SMPP/SMS: Use the message field for plain text messages - RCS: Use the content.body field for text content Both formats are supported for backward compatibility.

Body Params

applicationId

integer

required

application ID which the campaign belongs to

name

string

required

length between 1 and 255

campaign's name

senderName

string | null

sender name can be overwritten in this field

message

string | null

For SMPP/SMS campaigns: Campaign's message content.

It can contains custom variables to be replaced with contact's data, variables have this format : {{varName}}, and value must be replace when requesting a send operation.

For url shortening, it must be specified with a special variable with this format: {{url:the_url}}, for example: {{url:https://indigitall.com}}. The url will be shortened automatically when the campaign is being sent. Url protocol must be included.

If the unsubscription url is wanted in the message, special variable must be placed : {{url:unsubscribe}}

content

object | null

For RCS campaigns: New content structure for generic messaging. Use this format for RCS campaigns instead of the legacy message field. Both formats are supported for backward compatibility.

filters

object | null

campaign's filters

enabled

boolean

if campaigns is enabled or not

isCustomerService

boolean

the campaign is only for customer service

customValues

array of strings

List of variables associated with the campaign

customValues

Responses

200The created campaign

defaultError 5XX, 4XX