POST
/
api
/
v1
/
send-push-notifications
Send push notifications to user devices.
curl --request POST \
  --url http://api.clix.so/api/v1/send-push-notifications \
  --header 'Content-Type: application/json' \
  --header 'X-Clix-API-Key: <api-key>' \
  --header 'X-Clix-Project-ID: <api-key>' \
  --data '{
  "push_notifications": [
    {
      "target": {
        "device_id": "<string>"
      },
      "title": "<string>",
      "body": "<string>",
      "image_url": "<string>",
      "landing_url": "<string>"
    }
  ]
}'
{
  "delivery_results": [
    {
      "message_id": "<string>",
      "status": "DELIVERY_RESULT_STATUS_UNSPECIFIED",
      "additional_params": {
        "device_id": "<string>",
        "fcm_message_id": "<string>",
        "failure_reason": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-Clix-Project-ID
string
header
required

Project ID for authentication

​
X-Clix-API-Key
string
header
required

API Key for authentication

Body

application/json

Request body containing the push notifications to send.

Request schema for sending push notifications.

Response

200 - application/json

A successful response containing the delivery results for each push notification.

Response schema containing the delivery results for each push notification.