Sign in

v21

OpenAPI 3.1.0raw.githubusercontent.com2026-08-011060456.0 KB
Teams

Update a team member profile

Update a team member profile by user ID

patch/team-member-profiles/{team_id}/{user_id}

Path parameters

team_idstring required
user_idstring required

The ID of the user, or the special value me for the currently authenticated user

Example:3241a285-8329-4d69-8f3d-316e08cf140c

The ID of the user, or the special value me for the currently authenticated user

Request body

display_namestring

Human-readable team member display name. This is not a unique identifier. Note that this is separate from the display_name of the user.

profile_image_url'null' nullable

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

Example request

{
  "display_name": "John Doe",
  "profile_image_url": "https://example.com/image.jpg"
}

Response

Successful response

team_idstring required

The unique identifier of the team

user_idstring required

The unique identifier of the user

display_name'null' nullable

Human-readable team member display name. This is not a unique identifier. Note that this is separate from the display_name of the user.

profile_image_url'null' nullable

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

Example response

{
  "user": {
    "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
    "primary_email": "johndoe@example.com",
    "primary_email_verified": true,
    "primary_email_auth_enabled": true,
    "display_name": "John Doe",
    "selected_team": {
      "created_at_millis": 1630000000000,
      "server_metadata": {
        "key": "value"
      },
      "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"
      }
    },
    "selected_team_id": "team-id",
    "profile_image_url": "https://example.com/image.jpg",
    "signed_up_at_millis": 1630000000000,
    "client_metadata": {
      "key": "value"
    },
    "client_read_only_metadata": {
      "key": "value"
    },
    "server_metadata": {
      "key": "value"
    },
    "last_active_at_millis": 1630000000000,
    "country_code": "US",
    "risk_scores": {
      "sign_up": {
        "bot": 0,
        "free_trial_abuse": 0
      }
    }
  },
  "team_id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "display_name": "John Doe",
  "profile_image_url": "https://example.com/image.jpg"
}