Update a tour progress
Platform module
PATCH/tour-progress/{id}tourProgress.update
The caller's progress through one guided tour (0642). A tour is offered once (the row exists from then on), can be replayed by moving it to Started at step 0, and is never offered again. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability me.preferences.write.
- OAuth scopes: me.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the tour progress. |
Request body: TourProgressUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| tour_state | "Offered" | "Started" | "Completed" | "Dismissed" | No | Offered, Started, Completed or Dismissed. |
| step | integer | No | Last step reached, from 0.Constraints: range 0 to any |
{
"tour_state": "Started",
"step": 2
}Response 200: TourProgress
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the tour progress. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| membership_id | string (uuid) | Yes | Identifier of the membership of the caller, set by the server. |
| tour_key | string | Yes | Tour key from the help content.Constraints: pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)*$; length 0 to 100 |
| tour_state | "Offered" | "Started" | "Completed" | "Dismissed" | Yes | Offered, Started, Completed or Dismissed. |
| step | integer | Yes | Last step reached, from 0.Constraints: range 0 to any |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"tour_key": "atlas.getting-started",
"tour_state": "Started",
"step": 2
}Code samples
curl -X PATCH "$XOS_BASE_URL/tour-progress/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"tour_state":"Started","step":2}'const { data, etag } = await xos.tourProgress.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"tour_state": "Started",
"step": 2
}, { ifMatch: etag });response = xos.tour_progress.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"tour_state": "Started", "step": 2}, if_match=etag)xos tour-progress update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"tour_state":"Started","step":2}' --if-match auto