Skip to main content
POST
/
api
/
v1
/
live-activities:start
Start Live Activities on user devices.
curl --request POST \
  --url https://api.clix.so/api/v1/live-activities:start \
  --header 'Content-Type: application/json' \
  --header 'X-Clix-API-Key: <api-key>' \
  --header 'X-Clix-Project-ID: <api-key>' \
  --data '
{
  "live_activities": [
    {
      "target": {
        "project_user_id": "<string>"
      },
      "attributes_type": "<string>",
      "attributes": {},
      "content_state": {},
      "alert": {
        "title": "<string>",
        "body": "<string>"
      }
    }
  ]
}
'
{
  "delivery_results": [
    {
      "message_id": "<string>",
      "status": "DELIVERY_RESULT_STATUS_SUCCEED",
      "additional_params": {
        "device_id": "<string>",
        "fcm_message_id": "<string>",
        "failure_reason": "<string>"
      }
    }
  ]
}

Error Responses

400 Bad Request

Returned when the request contains invalid live activity parameters. Returns a plain text error message:
Invalid live activity parameters

401 Unauthorized

Authentication failed or invalid API key.

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 live activities to start.

Request schema for starting live activities.

live_activities
object[]

List of live activities to start.

Response

A successful response containing the delivery results for each live activity.

Response schema containing the delivery results for each live activity.

delivery_results
object[]

List of delivery results for each live activity.