Skip to main content
POST
/
live-activity
/
start
Start a Live Activity
curl --request POST \
  --url https://activitysmith.com/api/live-activity/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content_state": {
    "title": "ActivitySmith API Deployment",
    "subtitle": "start",
    "number_of_steps": 4,
    "current_step": 1,
    "type": "segmented_progress",
    "color": "yellow"
  }
}
'
{
  "success": true,
  "activity_id": "pLAr-Hnq9ZFW4sxlk43Lhbuok4GLh7UW",
  "devices_notified": 2,
  "users_notified": 1,
  "timestamp": "2026-01-28T09:57:22.929Z"
}

Authorizations

​
Authorization
string
header
required

Use your ActivitySmith API key. Example: Authorization: Bearer <API_KEY>

Body

application/json
​
content_state
object
required

Start payload requires title, number_of_steps, current_step, and type.

Response

Live Activity started

​
success
boolean
required
​
activity_id
string
required
​
timestamp
string<date-time>
required
​
devices_notified
integer
​
users_notified
integer