Update your personal profile
curl --request PATCH \
--url https://app.gc.ai/api/external/v1/me/profile \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"preferred_name": "<string>",
"use_name_in_chats": true,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": [
"<string>"
],
"custom_instructions": "<string>",
"privilege_marking_enabled": true,
"privilege_marking_text": "<string>",
"enter_to_submit": true,
"document_author_name": "<string>",
"enabled": true
}
'import requests
url = "https://app.gc.ai/api/external/v1/me/profile"
payload = {
"preferred_name": "<string>",
"use_name_in_chats": True,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": ["<string>"],
"custom_instructions": "<string>",
"privilege_marking_enabled": True,
"privilege_marking_text": "<string>",
"enter_to_submit": True,
"document_author_name": "<string>",
"enabled": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
preferred_name: '<string>',
use_name_in_chats: true,
role_title: '<string>',
jurisdiction_focus: '<string>',
practice_areas: ['<string>'],
custom_instructions: '<string>',
privilege_marking_enabled: true,
privilege_marking_text: '<string>',
enter_to_submit: true,
document_author_name: '<string>',
enabled: true
})
};
fetch('https://app.gc.ai/api/external/v1/me/profile', 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://app.gc.ai/api/external/v1/me/profile",
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([
'preferred_name' => '<string>',
'use_name_in_chats' => true,
'role_title' => '<string>',
'jurisdiction_focus' => '<string>',
'practice_areas' => [
'<string>'
],
'custom_instructions' => '<string>',
'privilege_marking_enabled' => true,
'privilege_marking_text' => '<string>',
'enter_to_submit' => true,
'document_author_name' => '<string>',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gc.ai/api/external/v1/me/profile"
payload := strings.NewReader("{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://app.gc.ai/api/external/v1/me/profile")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gc.ai/api/external/v1/me/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"preferred_name": "<string>",
"use_name_in_chats": true,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": [
"<string>"
],
"custom_instructions": "<string>",
"privilege_marking_enabled": true,
"privilege_marking_text": "<string>",
"enter_to_submit": true,
"document_author_name": "<string>",
"enabled": true,
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}Profiles
Update Your Personal Profile
Partially update the calling user’s personal profile. Omitted fields are left unchanged; nullable fields accept null to clear them. The profile is created on first write.
Display name and avatar are managed by your identity provider, not this API.
Requires a user-scoped key (u:gcai_...); org-scoped keys receive 403.
PATCH
/
me
/
profile
Update your personal profile
curl --request PATCH \
--url https://app.gc.ai/api/external/v1/me/profile \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"preferred_name": "<string>",
"use_name_in_chats": true,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": [
"<string>"
],
"custom_instructions": "<string>",
"privilege_marking_enabled": true,
"privilege_marking_text": "<string>",
"enter_to_submit": true,
"document_author_name": "<string>",
"enabled": true
}
'import requests
url = "https://app.gc.ai/api/external/v1/me/profile"
payload = {
"preferred_name": "<string>",
"use_name_in_chats": True,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": ["<string>"],
"custom_instructions": "<string>",
"privilege_marking_enabled": True,
"privilege_marking_text": "<string>",
"enter_to_submit": True,
"document_author_name": "<string>",
"enabled": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
preferred_name: '<string>',
use_name_in_chats: true,
role_title: '<string>',
jurisdiction_focus: '<string>',
practice_areas: ['<string>'],
custom_instructions: '<string>',
privilege_marking_enabled: true,
privilege_marking_text: '<string>',
enter_to_submit: true,
document_author_name: '<string>',
enabled: true
})
};
fetch('https://app.gc.ai/api/external/v1/me/profile', 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://app.gc.ai/api/external/v1/me/profile",
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([
'preferred_name' => '<string>',
'use_name_in_chats' => true,
'role_title' => '<string>',
'jurisdiction_focus' => '<string>',
'practice_areas' => [
'<string>'
],
'custom_instructions' => '<string>',
'privilege_marking_enabled' => true,
'privilege_marking_text' => '<string>',
'enter_to_submit' => true,
'document_author_name' => '<string>',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gc.ai/api/external/v1/me/profile"
payload := strings.NewReader("{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://app.gc.ai/api/external/v1/me/profile")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gc.ai/api/external/v1/me/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preferred_name\": \"<string>\",\n \"use_name_in_chats\": true,\n \"role_title\": \"<string>\",\n \"jurisdiction_focus\": \"<string>\",\n \"practice_areas\": [\n \"<string>\"\n ],\n \"custom_instructions\": \"<string>\",\n \"privilege_marking_enabled\": true,\n \"privilege_marking_text\": \"<string>\",\n \"enter_to_submit\": true,\n \"document_author_name\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"preferred_name": "<string>",
"use_name_in_chats": true,
"role_title": "<string>",
"jurisdiction_focus": "<string>",
"practice_areas": [
"<string>"
],
"custom_instructions": "<string>",
"privilege_marking_enabled": true,
"privilege_marking_text": "<string>",
"enter_to_submit": true,
"document_author_name": "<string>",
"enabled": true,
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}Authorizations
Body
application/json
Response
The updated personal profile
Last modified on June 15, 2026
Was this page helpful?