Sign in
Users

Update current user

Updates the currently authenticated user. Only the values provided will be updated.

patch/users/me

Request body

display_namestring

Human-readable user display name. This is not a unique identifier.

profile_image_urlstring

URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

client_metadataobject

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

selected_team_idstring

ID of the team currently selected by the user

totp_secret_base64string

Enables 2FA and sets a TOTP secret for the user. Set to null to disable 2FA.

primary_emailstring

Primary email

Example request

{
  "display_name": "John Doe",
  "profile_image_url": "https://example.com/image.jpg",
  "client_metadata": {
    "key": "value"
  },
  "selected_team_id": "team-id",
  "totp_secret_base64": "dG90cC1zZWNyZXQ=",
  "primary_email": "johndoe@example.com"
}

Response

Successful response

idstring required

The unique identifier of the user

primary_emailstring

Primary email

primary_email_verifiedboolean required

Whether the primary email has been verified to belong to this user

display_namestring

Human-readable user display name. This is not a unique identifier.

client_metadataobject

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

client_read_only_metadataobject

Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.

profile_image_urlstring

URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

signed_up_at_millisnumber required

The time the user signed up (identify) => (the number of milliseconds since epoch, January 1, 1970, UTC)

selected_team_idstring

ID of the team currently selected by the user

is_anonymousboolean required
is_restrictedboolean required

Whether the user is in restricted state (has signed up but not completed onboarding requirements)

restricted_by_adminboolean required

Whether the user is restricted by an administrator. Can be set manually or by sign-up rules.

restricted_by_admin_reasonstring

Public reason shown to the user explaining why they are restricted. Optional.

Example response

{
  "selected_team": {
    "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
    "display_name": "My Team",
    "profile_image_url": "https://example.com/image.jpg",
    "client_metadata": {
      "key": "value"
    },
    "client_read_only_metadata": {
      "key": "value"
    }
  },
  "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "primary_email": "johndoe@example.com",
  "primary_email_verified": true,
  "display_name": "John Doe",
  "client_metadata": {
    "key": "value"
  },
  "client_read_only_metadata": {
    "key": "value"
  },
  "profile_image_url": "https://example.com/image.jpg",
  "signed_up_at_millis": 1630000000000,
  "selected_team_id": "team-id"
}

Changes