Patch User Meta Data

PATCH

/v1/users/{user_id}/meta_data

Merge-patch a user’s meta_data JSONB. Requires users:write permission.

Parameters

Path Parameters

user_id

required

User Id

string

Request Body ^required

UserMetaDataPatch

Merge-patch a subset of the User.meta_data JSONB without overwriting unrelated keys.

object

patches

required

Patches

object

>= 1 properties

key

additional properties

any

Responses

200

Successful Response

Response[UserRead]

object

data

required

UserRead

Full representation of a User record returned from the API.

object

id

required

Id

string format: uuid

tenant_id

required

Tenant Id

string format: uuid

workos_org_id

required

Workos Org Id

string

created_at

required

Created At

string format: date-time

created_by_user_id

required

Created By User Id

string

updated_at

required

Updated At

string format: date-time

updated_by_user_id

required

Updated By User Id

string

archived_at

Any of:

string

string format: date-time

null

null

archived_by_user_id

Any of:

string

string

null

null

archive_reason

Any of:

string

string

null

null

deleted_at

Any of:

string

string format: date-time

null

null

deleted_by_user_id

Any of:

string

string

null

null

delete_reason

Any of:

string

string

null

null

workos_user_id

required

Workos User Id

string

email

required

Email

string

first_name

required

First Name

string

last_name

required

Last Name

string

avatar_url

Any of:

string

string

null

null

is_active

required

Is Active

boolean

meta_data

required

Meta Data

object

key

additional properties

any

last_sign_in_at

Any of:

string

string format: date-time

null

null

meta

ResponseMeta

Metadata included in every response envelope.

object

request_id

Any of:

string

string

null

null

organization_id

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object