POST
POST /v1/user_profiles/{user_profile_id}?beta=true — Claude API
Beta
Anthropic API key (required); https://api.anthropic.com
Claude APIUpdate User Profile
- Base URL
- https://api.anthropic.com
- Auth
- x-api-key: <ANTHROPIC_API_KEY>
- Last verified
- 2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 316 tokens · Vary: Accept
→ 316 tokens · Vary: Accept
Critical gotchas
Authentication uses the x-api-key header and requests also require an anthropic-version header.
The official OpenAPI URL is discovered from the SDK repository manifest and must remain under Anthropic's trusted Stainless storage prefix.
cURL
curl -X POST 'https://api.anthropic.com/v1/user_profiles/user-profile-id?beta=true' \ -H "x-api-key: $ANTHROPIC_API_KEY" \ -H 'anthropic-version: 2023-06-01' \ -H 'Content-Type: application/json' \ -d '{}'
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| user_profile_id | path | string | Yes | Path parameter user_profile_id |
| external_id | body | string | No | If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. |
| metadata | body | object | No | Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. |
| name | body | string | No | If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. |
| access_type | body | string | No | If present, replaces the stored access type. Omit to leave unchanged. |
| external_user_onboarded_at | body | string | No | If present, replaces the stored account creation time. Omit to leave unchanged; once set, the value cannot be cleared and `null` is rejected. Must be a complete RFC 3339 timestamp no more than 1 minute in the future. |
Response 200 OK
{
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
"type": "user_profile",
"external_id": "user_12345",
"name": "Example User",
"access_type": "application",
"trust_grants": {
"cyber": {
"status": "active"
}
},
"external_user_onboarded_at": "2024-11-02T08:15:00Z",
"metadata": {},
"created_at": "2026-03-15T10:00:00Z",
"updated_at": "2026-03-15T10:00:00Z"
} Get a free Claude API key → sponsored Affiliate link - we may earn a commission, at no extra cost to you.