Send the selected campaign to a specific list of devices (CSV)

The CSV file contains the list of devices to impact

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Important: You must also include the applicationId

applicationId is also a required field.
string: The id of the application propietary of the campaign.

Path Params
integer
required

Campaign's id

Body Params
file
required

A .csv file that you must upload with your list of device identifiers.
The CSV file must contain a header for device identification: either deviceId or externalId.
Only one of these headers should be present.
If you want to create campaigns with variable params for each device, the header must contain the name of every param as columns.

Example device list (using deviceId):

  deviceId
  be5d3f02-f486-47e2-bd98-5128e1c4b065
  be5d78f2-f486-47e2-bd98-5128e1c4b066
  be5d3f02-a345-47e2-bd98-1234wqe34241
  ...

Example device list (using externalId):

  externalId
  code123
  code456
  ...

Restrictions and limitations:

  • Empty rows (blank lines) are silently skipped and will not be imported.

  • Quoted multi-line CSV fields are NOT supported. RFC 4180 (section 2.6) allows
    a field value to span multiple lines if it is enclosed in double quotes. This
    endpoint does NOT support that feature. If the CSV contains such fields, the
    embedded newline will be misinterpreted as a row separator, corrupting the data
    or causing the request to fail with a generic error.

    Unsupported example:

      deviceId,description
      abc123,"This description
      spans two lines"
string
required

The id of the application propietary of the campaign

string

Schedule the push to this time. The format is ISO 8601, UTC-0

Ex:

2019-02-13T08:18:39.632Z

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

string
enum

Silent notification

Allowed:
Responses

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