Update User Onboarding State

PUT /api/v1/user/onboarding-state — request parameters and responses from the Menace Voice API schema.

2 min read

put/api/v1/user/onboarding-state

Request example

curl --request PUT \
  --url https://voice.menaceui.com/api/v1/user/onboarding-state \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "completed_at": "2026-08-10T12:00:00Z",
  "skipped": true,
  "seen_tooltips": [
    "<string>"
  ],
  "completed_actions": [
    "<string>"
  ]
}'

Response

{
  "completed_at": "2026-08-10T12:00:00Z",
  "skipped": false,
  "seen_tooltips": [
    "<string>"
  ],
  "completed_actions": [
    "<string>"
  ]
}

put/api/v1/user/onboarding-state

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

completed_atstring · null#

Show child attributes

Any of

skippedboolean · null#

Show child attributes

Any of

seen_tooltipsstring[] · null#

Show child attributes

Any of

completed_actionsstring[] · null#

Show child attributes

Any of

Responses

application/json

Successful Response

completed_atstring · null#

Show child attributes

Any of

skippedboolean#

Default: false

seen_tooltipsstring[]#

completed_actionsstring[]#

Get User Onboarding State Validate User Configurations