Skip to content
XOS Developers

tourProgress

Platform module · 4 operations

List tour progress rows

GET/tour-progress

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. Returns a cursor page of tour progress rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a tour progress

POST/tour-progress

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. Creates a tour progress. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a tour progress

GET/tour-progress/{id}

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. Returns one tour progress with its `ETag`. A tour progress the caller may not see returns 404.

Update a tour progress

PATCH/tour-progress/{id}

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.