Verified Campaigns Bulk API

This endpoint pushes the campaign details to the respective TC users.

Maximum 500 campaigns can be pushed in a single API call

Replace the {{BaseURL}} with the one mentioned here

POST {{BaseURL}/organisations/{organisationid}/campaigns/bulk-upload

{organisationid} : This can be taken directly from the self serve portal under the API Setup Page

Headers

Name	Value
Content-Type	Required application/json
Authorization	Required Bearer <token>

Body

In case of single object we can pass it as a raw json and we need not add the request in the file format.

File in below format -for multiple user records

216B

test.json.gz

Open

Name	Type	Validations	Description
campaigns	array of objects	min:1 max: 500	Campaign Details Object
campaign_id	string	min:1 max: 500	This can be taken from the self serve portal under the Campaigns tab
receiver_number	string	NA	Receiver Number, It is a 12 digit number with country code and without + sign ,also we can pass the number in the SHA256 format ,it also should be a 12 digit number with country code but without + sign
contents	array of object	min:1 max: 5	Depends on the number of touchpoints set up in selfserve portal
display_unit	string	enums cid acs-answered acs-missed-rejected mid business-profile	The display unit where the campaign will be played
deeplink	string	valid link	The external link to which the request should be routed
ttl	string	min:1 max: 365	Time to live (in days)

Response

200 OK

{
    "message": "Payload received successfully for processing"
}

500 Internal Server Error