Skip to content

Update a checklist item

PUT
/api/v1/onboarding/checklist

Mark a specific checklist item as completed or uncompleted. Validates item_id against the 9 valid item identifiers.

Authorizations

Request Body required

Request body for PUT /api/v1/onboarding/checklist.

Attributes: item_id: One of the 9 valid checklist item identifiers. completed: Whether the item should be marked complete.

object
completed
required

Whether the item is completed

boolean
item_id
required

One of the 9 valid checklist item IDs

string

Responses

200

Successful Response

Response for GET/PUT /api/v1/onboarding/checklist.

Contains the completion status for all 9 checklist items plus computed aggregate fields.

Attributes: setup_profile: Whether user completed their profile. setup_business_info: Whether user added business info. setup_first_integration: Whether user connected first integration. activate_read_brief: Whether user read first morning brief. activate_chat_agent: Whether user chatted with an agent. activate_review_decision: Whether user reviewed a decision. optimize_custom_kpi: Whether user created a custom KPI. optimize_second_integration: Whether user connected second integration. optimize_invite_team: Whether user invited a team member. all_complete: True when all 9 items are completed. completed_count: Number of completed items (0-9). total_count: Total number of items (always 9).

object
activate_chat_agent
boolean
activate_read_brief
boolean
activate_review_decision
boolean
all_complete
boolean
completed_count
integer
<= 9
optimize_custom_kpi
boolean
optimize_invite_team
boolean
optimize_second_integration
boolean
setup_business_info
boolean
setup_first_integration
boolean
setup_profile
boolean
total_count
integer
default: 9

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string