🧑‍🤝‍🧑Notify device groups

APIs to send push notification to a group of devices in your account, the request only works with account API key.

Your API Key is required for making any requests using our API, you can find it inside the console integrations page (https://push.techulus.com/console/integrations) or Account tab in mobile app. Team API keys can be found in the team details screen.

The authentication header (API Key) to be specified in the request is x-api-key

Send notification to a device group

post

Authorizations

api_key_header

x-api-keystringRequired

Account / Team API Key

Path parameters

groupIdstringRequired

Device Group ID

Body

application/json

titlestringRequired

Notification title

bodystringRequired

Notification Body

soundstringOptional

Notification sound, valid options are default, arcade, correct, fail, harp, reveal, bubble, doorbell, flute, money, scifi, clear, elevator, guitar, pop.

channelstringOptional

Notification channel, alphanumerical string and hyphens only.

Default: feed

linkstringOptional

Notification link (URL)

imagestringOptional

Notification image (URL)

timeSensitivebooleanOptional

Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode. (iOS only)

Default: false

Responses

200

Successful operation

application/json

400

Invalid input

application/json

401

Invalid authentication

application/json

500

Server Error

post

/notify/group/{groupId}

HTTPcURLJavaScriptPython

POST /api/v1/notify/group/{groupId} HTTP/1.1
Host: push.techulus.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "title": "text",
  "body": "text",
  "sound": "text",
  "channel": "feed",
  "link": "text",
  "image": "text",
  "timeSensitive": false
}

{
  "success": true,
  "message": "text",
  "responses": [
    {
      "success": true,
      "message": "text"
    }
  ]
}