Skip to main content
POST
/
devices
/
messages
Send cloud message to device
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/messages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceids": [
    123
  ],
  "port": 32768,
  "data": "<string>",
  "base64data": "<string>",
  "encrypted": true
}
'
{
  "success": true,
  "data": [
    {
      "deviceid": 123,
      "messageid": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Body

application/json
​
deviceids
integer[]
required

List of device IDs to send the message to

​
port
integer
required

Destination port number (1–65535)

Required range: 1 <= x <= 65535
​
protocol
enum<string>
required

Transport protocol for the message

Available options:
TCP,
UDP
​
data
string

Data to send (plain text). Max 10K

​
base64data
string

Data to send encoded in base64. Max 10K

​
encrypted
boolean
default:true

When true (default), encrypt the message payload

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true

​
data
object[]

One entry per device the message was queued for