Update a checklist item
const url = 'https://api.ultimateteam.ai/api/v1/onboarding/checklist';const options = { method: 'PUT', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"completed":true,"item_id":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.ultimateteam.ai/api/v1/onboarding/checklist \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "completed": true, "item_id": "example" }'Mark a specific checklist item as completed or uncompleted. Validates item_id against the 9 valid item identifiers.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”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
Whether the item is completed
One of the 9 valid checklist item IDs
Examplegenerated
{ "completed": true, "item_id": "example"}Responses
Section titled “ Responses ”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
Example
{ "activate_chat_agent": false, "activate_read_brief": false, "activate_review_decision": false, "all_complete": false, "completed_count": 0, "optimize_custom_kpi": false, "optimize_invite_team": false, "optimize_second_integration": false, "setup_business_info": false, "setup_first_integration": false, "setup_profile": false, "total_count": 9}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}