Skip to main content
PATCH
Update my profile

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Body

application/json

Profile fields to update.

Fields of the current user profile to update. Omitted fields are left unchanged.

name
string

New display name.

Required string length: 1 - 120
Example:

"Ada Lovelace"

handle
string

New unique handle.

Pattern: ^[a-zA-Z0-9_-]{2,32}$
Example:

"ada"

Response

The updated user profile.

A Scribe user profile.

id
string
required

User id.

Example:

"usr_V1StGXR8_Z5jdHi6BmyT"

email
string<email>
required

Email address.

name
string | null
required

Display name.

Example:

"Ada Lovelace"

handle
string | null
required

Unique short handle.

Example:

"ada"

avatarUrl
string | null
required

URL of the avatar image, or null when none is set.

Example:

"/api/uploads/users/usr_V1StGXR8_Z5jdHi6BmyT/avatar"

createdAt
integer
required

When the user account was created (epoch milliseconds).

Example:

1752624000000

updatedAt
integer
required

When the user profile was last updated (epoch milliseconds).

Example:

1752624000000