Skip to main content
PATCH
Aplica um patch parcial ao estado do guia

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Body

application/json

Patch parcial do estado do guia. Replays do mesmo patch são idempotentes.

Patch parcial do estado do guia. Replays do mesmo patch são idempotentes.

tours
object

Tours a atualizar. Cada entrada enviada SUBSTITUI integralmente a armazenada daquele tour, exceto quando a armazenada tem contentVersion maior. Tours omitidos são preservados.

screensVisited
object

Rotas visitadas a registrar (timestamp ISO 8601). União com as armazenadas; em conflito vence o timestamp mais antigo (primeira visita).

invites
object

Convites (toasts) exibidos a registrar por tour (timestamp ISO 8601). União com os armazenados, deduplicando exatos e mantendo os 5 mais recentes.

preferences
object

Preferências a atualizar (merge raso: só as chaves enviadas).

Response

200 - application/json

Default Response

state
object
required

Estado completo do guia de onboarding do painel para um usuário em uma organização.

updatedAt
string | null
required

Timestamp ISO 8601 da última escrita, ou null quando o usuário ainda não tem estado gravado (resposta com o estado inicial).

Example:

"2026-07-07T12:00:00.000Z"