---
title: "Start Live Activities on user devices."
method: POST
path: "/api/v1/live-activities:start"
tags: ["ClixExternalService"]
---

# Start Live Activities on user devices.

`POST /api/v1/live-activities:start`

## Request

- Base URL: `https://api.clix.so`
- URL: `https://api.clix.so/api/v1/live-activities:start`
- Auth: API key in header `X-Clix-Project-ID` and API key in header `X-Clix-API-Key`

This endpoint starts iOS Live Activities on one or more user devices using Push to Start.

## Request body

- V1StartLiveActivitiesRequest: Request schema for starting live activities.
  - `live_activities` Clixexternalv1LiveActivity[]: List of live activities to start.
    - `target` union, required: Target information for the live activity. Only one of project_user_id, device_id, or user_id should be present.
      - object
        - `project_user_id` string, required: Project-specific user ID for targeting.
      - object
        - `device_id` string, required: ID of the target device.
      - object
        - `user_id` string, required: ID of the target user.
    - `attributes_type` string, required: The name of the ActivityAttributes type defined in your iOS app (e.g., 'DeliveryAttributes').
    - `attributes` object, required: Initial values for ActivityAttributes (static data that doesn't change).
    - `content_state` object, required: Initial values for ContentState (dynamic data that updates in real-time).
    - `alert` Clixexternalv1LiveActivityAlert: Alert notification displayed when starting a Live Activity.
      - `title` string, required: Title of the alert notification.
      - `body` string, required: Body content of the alert notification.

## Response `200`

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

- V1StartLiveActivitiesResponse: Response schema containing the delivery results for each live activity.
  - `delivery_results` Clixexternalv1DeliveryResult[]: List of delivery results for each live activity.
    - `message_id` string: Unique ID of the push notification message.
    - `status` 'DELIVERY_RESULT_STATUS_SUCCEED' | 'DELIVERY_RESULT_STATUS_FAILED'
    - `additional_params` Clixexternalv1DeliveryResultAdditionalParams
      - `device_id` string
      - `fcm_message_id` string
      - `failure_reason` string

## Other responses

- `400`: Bad request - invalid parameters

---

[API](https://skmtc.dev/clix/apis/clix-external-v1-clix-proto.md) - [All operations](https://skmtc.dev/clix/apis/clix-external-v1-clix-proto/llms.txt) - [OpenAPI document](https://skmtc.dev/clix/apis/clix-external-v1-clix-proto/revisions/b5048a49e843?raw)