Securely send a notification

Deprecated use /campaign/{id}/send/one instead.

Securely send a notification to a specific device. Data in securedData filed is encrypted before sending.

The device field 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",
  "device" : "deviceId1"
}
  • Example with externalId
{
  "idType": "externalId",
  "device" : "externalId1"
}
  • Example with customizable fields. Keep in mind that campaign must cointains these fields, in this example, {{myfield1}} and {{myfield2}}
{
  "idType": "deviceId",
  "device" : "deviceId1",
  "customFields": { 
    "myfield1" : "fieldvalue"
    "myfield2" : "fieldvalue"
  }
}
---
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

id from the campaign that you want to send

Query Params
boolean
Defaults to true

choose if the message is encrypted, by default it will be true

boolean
Defaults to true

choose if the received push event is registered, by default it will take the value from the application configuration

Body Params
string

Other data

string

Other data to send encrypted to device

string
enum
required
Defaults to deviceId

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

Allowed:
string
required

device reference, can be deviceId or externalId, depending on the idType property value.

customFields
object

Object with campaing's customizable fields, must be one key per field and its value.

boolean
Defaults to true

Indicates if the notification can be disponsabled by the user

boolean
Defaults to false

Indicate if it is a silent delivery. Only available for android, ios and harmony.

Responses

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