Values to create a WhatsApp Campaign
Request body which must comply to the following JSON Schema:
{
"required" : [ "name", "recipients", "scheduledAt", "templateId" ],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the WhatsApp campaign creation",
"example" : "Test Campaign"
},
"templateId" : {
"type" : "integer",
"description" : "Id of the WhatsApp template in **approved** state",
"example" : 19
},
"scheduledAt" : {
"type" : "string",
"description" : "Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00**\n",
"example" : "2017-06-01T12:30:00+02:00"
},
"recipients" : {
"type" : "object",
"properties" : {
"excludedListIds" : {
"type" : "array",
"description" : "List ids to exclude from the campaign",
"items" : {
"type" : "integer",
"format" : "int64",
"example" : 8
}
},
"listIds" : {
"type" : "array",
"description" : "**Mandatory if scheduledAt is not empty**. List Ids to send the campaign to\n",
"items" : {
"type" : "integer",
"format" : "int64",
"example" : 32
}
},
"segments" : {
"type" : "array",
"description" : "**Mandatory if listIds are not used**. Segment ids to send the campaign to.\n",
"items" : {
"type" : "integer",
"format" : "int64",
"example" : 23
}
}
},
"description" : "Segment ids and List ids to include/exclude from campaign"
}
}
}
