Ctrl+K

Patch guided checklist properties

patch/api/usermanagement/v1/users/{userId}/properties/guided-checklist

Updates only the guidedChecklist field of an existing user properties record.

Path Parameters

  • userIdstringRequired
    External user ID

Request Body

Guided checklist properties to apply
track string required
Guided checklist track
Allowed values: A B
roles array[string]
The user's roles in the requested organization, resolved at read time from role-user membership. Used by the server to filter visible steps. Values written via PUT/PATCH are stored but overwritten on GET by the resolved values, so this field always reflects the user's current roles in the org rather than a stored snapshot.
productInterests array[string]
User product interests
steps array[object]
Checklist steps
stepId string required
Unique step identifier
title string required
Display title
description string required
Step description
ctaLabel string required
Call-to-action button label
ctaRoute string required
Navigation route for the CTA
status string required
Step completion status
Allowed values: UP_NEXT IN_PROGRESS COMPLETED SKIPPED
sortOrder integer required
Display sort order
completedAt string <date-time>
When the step was completed
completedBy string <uuid>
User who completed the step
sourceRoles array[string]
Roles that generated this step
computedAt string <date-time>required
When the checklist was last computed
completedAt string <date-time>
When the checklist was completed
dismissedAt string <date-time>
When the checklist was dismissed

200 Response

userId string required
External user ID
guidedChecklist object
track string required
Guided checklist track
Allowed values: A B
roles array[string]
The user's roles in the requested organization, resolved at read time from role-user membership. Used by the server to filter visible steps. Values written via PUT/PATCH are stored but overwritten on GET by the resolved values, so this field always reflects the user's current roles in the org rather than a stored snapshot.
productInterests array[string]
User product interests
steps array[object]
Checklist steps
computedAt string <date-time>required
When the checklist was last computed
completedAt string <date-time>
When the checklist was completed
dismissedAt string <date-time>
When the checklist was dismissed
createdDate string <date-time>required
When the record was created
modifiedDate string <date-time>required
When the record was last modified