Skip to main content
PATCH
Core - Update identity profile
Related guide: Identities guide. See the Identities guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Identity ID to update.

Body

application/json
display_name
string

New display name. Omit to keep the current display name.

email
string

New email address. Omit to keep the current email, or send an empty string to clear it.

avatar_url
string

New avatar image URL. Omit to keep the current avatar URL.

tags
string[]

Replacement tag list. Leave empty to clear tags.

metadata
object

Replacement custom JSON metadata.

Response

OK

identity
object
required

Updated identity.