Skip to main content
POST
Start Live Activities on user devices.

Error Responses

400 Bad Request

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

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.