Send the selected campaign targeting the specified devices

Prepares the campaign to be sent to specified devices applying campaign's filters. The devices in the list can be refered by its deviceId or externalId, this can be set with idType parameter, which is deviceId by default.

  • Example with deviceId
{
  "idType": "deviceId",
  "deviceList" : [
    {
      "id" : "deviceId1"
    },
    {
      "id": "deviceId2"
    }
  ]
}
  • Example with externalId
{
  "idType": "externalId",
  "deviceList" : [
    {
      "id" : "externalId1"
    },
    {
      "id": "externalId2"
    }
  ]
}

If the campaign contains customizable fields, those can be included in the list.

  • Example with customizable fields. Keep in mind that campaign must cointains these fields, in this example, {{myfield1}} and {{myfield2}}
{
  "idType": "deviceId",
  "deviceList" : [
    {
      "id" : "deviceId1"
      "customFields":
        {
          "myfield1" : "fieldvalue"
          "myfield2" : "fieldvalue"
        }
    },
    {
      "id": "deviceId2"
      "customFields":
        {
          "myfield1" : "fieldvalue"
          "myfield2" : "fieldvalue"
        }
    }
  ]
}
Recent Requests
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 reference to the sending.

string
enum
Defaults to deviceId

Set de the id type for the deviceList. It can be deviceId or externalId

Allowed:
deviceList
array of objects
required
≥ 1

Array of devices that will be target of the sending. It can includes customizable fields if needed in customFields property.

deviceList*
integer
enum

Set the contentAvailable parameter for iOS pushes

Allowed:
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

contentState
object

Object with attributes to send live activity push

Responses

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