Skip to main content
PATCH
Update user

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

userId
string
required

Your id for the end user (the user_id sent to POST /v1/token).

Example:

"user_4821"

Body

application/json
name
string | null

New display name. null clears it; omit to leave it untouched.

Example:

"Ada Lovelace"

tools_auth
object
Example:
group_id
string

Move the user to this group. An unseen id creates the group; rename or cap it via PATCH /v1/groups/{groupId}.

Example:

"grp_84f20c19"

Response

What was updated

user
object
providers
string[]

Provider ids whose stored credentials were replaced.

removed_providers
string[]

Provider ids whose stored credentials were deleted (null entries).

sessions_refreshed
integer

Live sessions re-pointed at the new group.

schedules_refreshed
integer

Scheduled workflows re-pointed at the new group.

group_id
string | null

The group the user was moved to, when one was sent.