DocumentationUser GuideDeveloper GuideAPITechnology Partners
For Developers
GO TO CONSOLECONTACT US !
Start typing to search…

Send the selected campaign

post deprecatedhttps://api.indigitall.com/v1/campaign//send

THIS METHOD IS DEPRECATED, PLEASE USE /send/all OR /send/list ENDPOINTS

Prepare the campaign to be sent instantly or when it is decided. Through the body you can schedule the delivery date (scheduleAt), send a specific list of devices (deviceList) or a group of devices that share the same external code (externalIds) and program it according to an event, passing the id of that event (triggerId).
If the campaign is of type custom, through the property deviceCustomList or externalCustomList you can send the data for each device.
The deviceList, deviceCustomList and externalCustomList fields have preference over the data added through a csv with the endpoint /campaign/{id}/targets

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Campaign's id

Body Params
string

Schedule the push to this time. The date format is ISO-8601.
If a scheduled date already exists, the oldest one not sent will be canceled.
The date must be greater than the current date

Ex:

        2019-02-13T08:18:39.632Z
integer

Add trigger to the sending, whose id corresponds to the one entered.

deviceList
array of strings

Array of device codes. If exists, the campaign will send to these devices
Example:

[ "12654qew-qweqe-123swe", "asad4q4e65a-asqwe4785-asd45-qewer12",...,"asd1351das-sdfssdfs-415ds4-we48" ]
deviceList
deviceCustomList
array of objects

Array of device codes with custom fields. If it exists, the campaign will be sent to these devices. Each object that is part of the array must contain the deviceId of the device and the same number of properties as of values to replace. Each property with the name of the field to be replaced and the value to be entered.
deviceId must be unique.
Example:

[
  { "deviceId":"12654qew-qweqe-123swe", "data1": 12312, "data2": "pweo323o",...,"datan":"asdas" },
  ...
]
deviceCustomList
externalIds
array of strings

Array of external codes, similar a tags for devices. Useful if you want to send to several devices of the same user identified by this code
Example:

["prueba1", "test1", ..., "n"]
externalIds
externalCustomList
array of objects

Array of external codes with custom fields, similar a tags for devices. Useful if you want to send to several devices of the same user identified by this code
Each object that is part of the array must contain the externalId and the same number of properties as of values to replace.
Each property with the name of the field to be replaced and the value to be entered.
externalId must be unique.
Example:

[
{ "externalId":"12654qew-qweqe-123swe", "data1": 12312, "data2": "pweo323o",...,"datan":"asdas" },
...
]

externalCustomList
string

Activate the smart send functionality and set the day the send should be made.
The date must have an ISO-8601 format of the type YYYY-MM-DD.
If this property is set, it is mandatory to also specify the smartTimezone property.

string

Indicates the time zone that we must use to interpret the date indicated in the smartTime field.
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Example: Europe/Madrid

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?