Update a tour progress

Módulo Platform

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.

Requiere la capacidad me.preferences.write.
Alcances de OAuth: me.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

tourProgress.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the tour progress.

Cuerpo de la solicitud: TourProgressUpdate

tourProgress.update: TourProgressUpdate
Campo	Tipo	Obligatorio	Descripción
tour_state	"Offered" \| "Started" \| "Completed" \| "Dismissed"	No	Offered, Started, Completed or Dismissed.
step	integer	No	Last step reached, from 0.Restricciones: range 0 to any

{
  "tour_state": "Started",
  "step": 2
}

Respuesta 200: TourProgress

tourProgress.update: TourProgress
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the tour progress.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
membership_id	string (uuid)	Sí	Identifier of the membership of the caller, set by the server.
tour_key	string	Sí	Tour key from the help content.Restricciones: pattern ^[a-z][a-z0-9-](\.[a-z][a-z0-9-])*$; length 0 to 100
tour_state	"Offered" \| "Started" \| "Completed" \| "Dismissed"	Sí	Offered, Started, Completed or Dismissed.
step	integer	Sí	Last step reached, from 0.Restricciones: 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
}

Ejemplos de código

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