🧑‍🤝‍🧑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

Path parameters

groupIdstringrequired

Device Group ID

Body

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.

channelstring · default: "feed"optional

Notification channel, alphanumerical string and hyphens only.

linkstringoptional

Notification link (URL)

imagestringoptional

Notification image (URL)

timeSensitiveboolean · default: falseoptional

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://push.techulus.com/api/v1/notify/group/{groupId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "body": "text",
    "sound": "text",
    "channel": "text",
    "link": "text",
    "image": "text",
    "timeSensitive": true
  }'

200

400

401

500

200

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

Successful operation