Skip to main content
PATCH
/
team-member-profiles
/
{team_id}
/
{user_id}
Update a team member profile
curl --request PATCH \
  --url https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "John Doe",
  "profile_image_url": "https://example.com/image.jpg"
}
'
import requests

url = "https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}"

payload = {
"display_name": "John Doe",
"profile_image_url": "https://example.com/image.jpg"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({display_name: 'John Doe', profile_image_url: 'https://example.com/image.jpg'})
};

fetch('https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'display_name' => 'John Doe',
'profile_image_url' => 'https://example.com/image.jpg'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}"

payload := strings.NewReader("{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\"\n}"

response = http.request(request)
puts response.read_body
{
  "user": {
    "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
    "primary_email_verified": true,
    "primary_email_auth_enabled": true,
    "signed_up_at_millis": 1630000000000,
    "last_active_at_millis": 1630000000000,
    "is_anonymous": true,
    "is_restricted": false,
    "restricted_by_admin": false,
    "risk_scores": {
      "sign_up": {
        "bot": 0,
        "free_trial_abuse": 0
      }
    },
    "primary_email": "johndoe@example.com",
    "display_name": "John Doe",
    "selected_team": {
      "created_at_millis": 1630000000000,
      "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
      "display_name": "My Team",
      "server_metadata": {
        "key": "value"
      },
      "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",
    "client_metadata": {
      "key": "value"
    },
    "client_read_only_metadata": {
      "key": "value"
    },
    "server_metadata": {
      "key": "value"
    },
    "restricted_reason": null,
    "restricted_by_admin_reason": null,
    "restricted_by_admin_private_details": null,
    "country_code": "US"
  },
  "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"
}

Path Parameters

team_id
string
required
user_id
string
required

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

Example:

"3241a285-8329-4d69-8f3d-316e08cf140c"

Body

application/json
display_name
string

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

Example:

"John Doe"

profile_image_url
string

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:

"https://example.com/image.jpg"

Response

200 - application/json

Successful response

user
object
required
team_id
string
required

The unique identifier of the team

Example:

"ad962777-8244-496a-b6a2-e0c6a449c79e"

user_id
string
required

The unique identifier of the user

Example:

"3241a285-8329-4d69-8f3d-316e08cf140c"

display_name
string

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

Example:

"John Doe"

profile_image_url
string

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:

"https://example.com/image.jpg"