Update current user

curl --request PATCH \
  --url https://api.hexclave.com/api/v1/users/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

import requests

url = "https://api.hexclave.com/api/v1/users/me"

payload = {
    "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"
}
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',
    client_metadata: {key: 'value'},
    selected_team_id: 'team-id',
    totp_secret_base64: 'dG90cC1zZWNyZXQ=',
    primary_email: 'johndoe@example.com'
  })
};

fetch('https://api.hexclave.com/api/v1/users/me', 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/users/me",
  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',
    'client_metadata' => [
        'key' => 'value'
    ],
    'selected_team_id' => 'team-id',
    'totp_secret_base64' => 'dG90cC1zZWNyZXQ=',
    'primary_email' => 'johndoe@example.com'
  ]),
  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/users/me"

	payload := strings.NewReader("{\n  \"display_name\": \"John Doe\",\n  \"profile_image_url\": \"https://example.com/image.jpg\",\n  \"client_metadata\": {\n    \"key\": \"value\"\n  },\n  \"selected_team_id\": \"team-id\",\n  \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n  \"primary_email\": \"johndoe@example.com\"\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/users/me")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"John Doe\",\n  \"profile_image_url\": \"https://example.com/image.jpg\",\n  \"client_metadata\": {\n    \"key\": \"value\"\n  },\n  \"selected_team_id\": \"team-id\",\n  \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n  \"primary_email\": \"johndoe@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hexclave.com/api/v1/users/me")

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  \"client_metadata\": {\n    \"key\": \"value\"\n  },\n  \"selected_team_id\": \"team-id\",\n  \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n  \"primary_email\": \"johndoe@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "primary_email_verified": true,
  "signed_up_at_millis": 1630000000000,
  "is_anonymous": true,
  "is_restricted": false,
  "restricted_by_admin": false,
  "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"
    }
  },
  "primary_email": "johndoe@example.com",
  "display_name": "John Doe",
  "client_metadata": {
    "key": "value"
  },
  "client_read_only_metadata": {
    "key": "value"
  },
  "profile_image_url": "https://example.com/image.jpg",
  "selected_team_id": "team-id",
  "restricted_reason": null,
  "restricted_by_admin_reason": null
}

PATCH

users

Update current user

curl --request PATCH \
  --url https://api.hexclave.com/api/v1/users/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

import requests

url = "https://api.hexclave.com/api/v1/users/me"

payload = {
    "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"
}
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',
    client_metadata: {key: 'value'},
    selected_team_id: 'team-id',
    totp_secret_base64: 'dG90cC1zZWNyZXQ=',
    primary_email: 'johndoe@example.com'
  })
};

fetch('https://api.hexclave.com/api/v1/users/me', 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/users/me",
  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',
    'client_metadata' => [
        'key' => 'value'
    ],
    'selected_team_id' => 'team-id',
    'totp_secret_base64' => 'dG90cC1zZWNyZXQ=',
    'primary_email' => 'johndoe@example.com'
  ]),
  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/users/me"

	payload := strings.NewReader("{\n  \"display_name\": \"John Doe\",\n  \"profile_image_url\": \"https://example.com/image.jpg\",\n  \"client_metadata\": {\n    \"key\": \"value\"\n  },\n  \"selected_team_id\": \"team-id\",\n  \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n  \"primary_email\": \"johndoe@example.com\"\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/users/me")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"John Doe\",\n  \"profile_image_url\": \"https://example.com/image.jpg\",\n  \"client_metadata\": {\n    \"key\": \"value\"\n  },\n  \"selected_team_id\": \"team-id\",\n  \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n  \"primary_email\": \"johndoe@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hexclave.com/api/v1/users/me")

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  \"client_metadata\": {\n    \"key\": \"value\"\n  },\n  \"selected_team_id\": \"team-id\",\n  \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n  \"primary_email\": \"johndoe@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "primary_email_verified": true,
  "signed_up_at_millis": 1630000000000,
  "is_anonymous": true,
  "is_restricted": false,
  "restricted_by_admin": false,
  "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"
    }
  },
  "primary_email": "johndoe@example.com",
  "display_name": "John Doe",
  "client_metadata": {
    "key": "value"
  },
  "client_read_only_metadata": {
    "key": "value"
  },
  "profile_image_url": "https://example.com/image.jpg",
  "selected_team_id": "team-id",
  "restricted_reason": null,
  "restricted_by_admin_reason": null
}

Body

application/json

display_name

enum<string> | null

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

Available options:

null

Example:

"John Doe"

profile_image_url

enum<string> | null

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.

Available options:

null

Example:

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

client_metadata

object | null

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

Example:

{ "key": "value" }

selected_team_id

enum<string> | null

ID of the team currently selected by the user

Available options:

null

Example:

"team-id"

totp_secret_base64

enum<string> | null

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

Available options:

null

Example:

"dG90cC1zZWNyZXQ="

primary_email

enum<string> | null

Primary email

Available options:

null

Example:

"johndoe@example.com"

Response

200 - application/json

Successful response

string

required

The unique identifier of the user

Example:

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

primary_email_verified

boolean

required

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

Example:

true

signed_up_at_millis

number

required

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

Example:

1630000000000

is_anonymous

boolean

required

is_restricted

boolean

required

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

Example:

false

restricted_by_admin

boolean

required

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

Example:

false

selected_team

object | null

Show child attributes

primary_email

enum<string> | null

Primary email

Available options:

null

Example:

"johndoe@example.com"

display_name

enum<string> | null

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

Available options:

null

Example:

"John Doe"

client_metadata

object | null

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

Example:

{ "key": "value" }

client_read_only_metadata

object | null

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.

Example:

{ "key": "value" }

profile_image_url

enum<string> | null

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.

Available options:

null

Example:

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

selected_team_id

enum<string> | null

ID of the team currently selected by the user

Available options:

null

Example:

"team-id"

restricted_reason

object | null

The reason why the user is restricted (e.g., type: "email_not_verified", "anonymous", or "restricted_by_administrator"), null if not restricted

Show child attributes

Example:

null

restricted_by_admin_reason

enum<string> | null

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

Available options:

null

Example:

null

⌘I

Client API

Server API

Webhooks

Update current user

Body

Response