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"
        }
    }
  ]
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!