> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clix.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Start Live Activities

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

## 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.


## OpenAPI

````yaml POST /api/v1/live-activities:start
openapi: 3.1.0
info:
  title: clix/external/v1/clix.proto
  version: version not set
servers:
  - url: https://api.clix.so
security:
  - ProjectIdAuth: []
    ApiKeyAuth: []
tags:
  - name: ClixExternalService
paths:
  /api/v1/live-activities:start:
    post:
      tags:
        - ClixExternalService
      summary: Start Live Activities on user devices.
      description: >-
        This endpoint starts iOS Live Activities on one or more user devices
        using Push to Start.
      operationId: ClixExternalService_StartLiveActivities
      requestBody:
        required: true
        description: Request body containing the live activities to start.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1StartLiveActivitiesRequest'
      responses:
        '200':
          description: >-
            A successful response containing the delivery results for each live
            activity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1StartLiveActivitiesResponse'
        '400':
          description: Bad request - invalid parameters
          content:
            text/plain:
              schema:
                type: string
                example: Invalid live activity parameters
components:
  schemas:
    v1StartLiveActivitiesRequest:
      type: object
      description: Request schema for starting live activities.
      properties:
        live_activities:
          type: array
          description: List of live activities to start.
          items:
            $ref: '#/components/schemas/clixexternalv1LiveActivity'
            type: object
    v1StartLiveActivitiesResponse:
      type: object
      description: Response schema containing the delivery results for each live activity.
      properties:
        delivery_results:
          type: array
          description: List of delivery results for each live activity.
          items:
            $ref: '#/components/schemas/clixexternalv1DeliveryResult'
            type: object
    clixexternalv1LiveActivity:
      type: object
      description: A live activity to be started on a user device.
      properties:
        target:
          $ref: '#/components/schemas/clixexternalv1LiveActivityTarget'
          description: Target device and/or user for the live activity.
        attributes_type:
          type: string
          description: >-
            The name of the ActivityAttributes type defined in your iOS app
            (e.g., 'DeliveryAttributes').
        attributes:
          type: object
          description: >-
            Initial values for ActivityAttributes (static data that doesn't
            change).
          additionalProperties: true
        content_state:
          type: object
          description: >-
            Initial values for ContentState (dynamic data that updates in
            real-time).
          additionalProperties: true
        alert:
          $ref: '#/components/schemas/clixexternalv1LiveActivityAlert'
          description: >-
            Push notification alert displayed when the Live Activity starts. If
            not provided, defaults to title: 'Live Activity', body: 'Started'.
      required:
        - target
        - attributes_type
        - attributes
        - content_state
    clixexternalv1DeliveryResult:
      type: object
      description: Result of a push notification delivery attempt.
      properties:
        message_id:
          type: string
          description: Unique ID of the push notification message.
        status:
          $ref: '#/components/schemas/clixexternalv1DeliveryResultStatus'
          description: Delivery status of the push notification.
        additional_params:
          $ref: '#/components/schemas/clixexternalv1DeliveryResultAdditionalParams'
          description: Additional parameters related to the delivery result.
    clixexternalv1LiveActivityTarget:
      type: object
      description: >-
        Target information for the live activity. Only one of project_user_id,
        device_id, or user_id should be present.
      oneOf:
        - properties:
            project_user_id:
              type: string
              description: Project-specific user ID for targeting.
          required:
            - project_user_id
        - properties:
            device_id:
              type: string
              description: ID of the target device.
          required:
            - device_id
        - properties:
            user_id:
              type: string
              description: ID of the target user.
          required:
            - user_id
    clixexternalv1LiveActivityAlert:
      type: object
      description: Alert notification displayed when starting a Live Activity.
      properties:
        title:
          type: string
          description: Title of the alert notification.
        body:
          type: string
          description: Body content of the alert notification.
      required:
        - title
        - body
    clixexternalv1DeliveryResultStatus:
      type: string
      enum:
        - DELIVERY_RESULT_STATUS_SUCCEED
        - DELIVERY_RESULT_STATUS_FAILED
    clixexternalv1DeliveryResultAdditionalParams:
      type: object
      properties:
        device_id:
          type: string
        fcm_message_id:
          type: string
        failure_reason:
          type: string
  securitySchemes:
    ProjectIdAuth:
      type: apiKey
      in: header
      name: X-Clix-Project-ID
      description: Project ID for authentication
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Clix-API-Key
      description: API Key for authentication

````