Update User Profile

BetaUserProfile Beta.UserProfiles.Update(parameters, cancellationToken = default)

POST/v1/user_profiles/{user_profile_id}

Update User Profile

Parameters

UserProfileUpdateParams parameters

required string userProfileID

Path param: Path parameter user_profile_id

Body param: How the platform uses the API on behalf of the entity this profile represents. application: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. passthrough: the platform resells raw inference, and the profile identifies the resold-to company.

Application("application")

Passthrough("passthrough")

string? externalID

Body param: If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters.

minLength1

maxLength255

DateTimeOffset externalUserOnboardedAt

Body param: A timestamp in RFC 3339 format

formatdate-time

IReadOnlyDictionary<string, string> metadata

Body param: 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.

string? name

Body param: If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters.

minLength1

maxLength255

IReadOnlyList<AnthropicBeta> betas

Header param: Optional header to specify the beta version(s) you want to use.

MessageBatches2024_09_24("message-batches-2024-09-24")

PromptCaching2024_07_31("prompt-caching-2024-07-31")

ComputerUse2024_10_22("computer-use-2024-10-22")

ComputerUse2025_01_24("computer-use-2025-01-24")

Pdfs2024_09_25("pdfs-2024-09-25")

TokenCounting2024_11_01("token-counting-2024-11-01")

TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")

Output128k2025_02_19("output-128k-2025-02-19")

FilesApi2025_04_14("files-api-2025-04-14")

McpClient2025_04_04("mcp-client-2025-04-04")

McpClient2025_11_20("mcp-client-2025-11-20")

DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")

InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")

CodeExecution2025_05_22("code-execution-2025-05-22")

ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")

Context1m2025_08_07("context-1m-2025-08-07")

ContextManagement2025_06_27("context-management-2025-06-27")

ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")

Skills2025_10_02("skills-2025-10-02")

FastMode2026_02_01("fast-mode-2026-02-01")

Output300k2026_03_24("output-300k-2026-03-24")

UserProfiles2026_03_24("user-profiles-2026-03-24")

UserProfiles2026_08_18("user-profiles-2026-08-18")

AdvisorTool2026_03_01("advisor-tool-2026-03-01")

ManagedAgents2026_04_01("managed-agents-2026-04-01")

CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")

Dreaming2026_04_21("dreaming-2026-04-21")

ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")

ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")

ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")

FallbackCredit2026_06_01("fallback-credit-2026-06-01")

FallbackCredit2026_07_01("fallback-credit-2026-07-01")

AgentMemory2026_07_22("agent-memory-2026-07-22")

MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")

Compact2026_01_12("compact-2026-01-12")

ComputerUse2025_11_24("computer-use-2025-11-24")

McpTunnels2026_06_22("mcp-tunnels-2026-06-22")

StructuredOutputs2025_11_13("structured-outputs-2025-11-13")

TaskBudgets2026_03_13("task-budgets-2026-03-13")

ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")

CEUserManagement2026_07_13("ce-user-management-2026-07-13")

MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")

ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")

MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")

Returns

class BetaUserProfile:

Update User Profile

UserProfileUpdateParams parameters = new()
{
    UserProfileID = "uprof_011CZkZCu8hGbp5mYRQgUmz9"
};

var betaUserProfile = await client.Beta.UserProfiles.Update(parameters);

Console.WriteLine(betaUserProfile);

Response 200

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "created_at": "2026-03-15T10:00:00Z",
  "metadata": {},
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "type": "user_profile",
  "updated_at": "2026-03-15T10:00:00Z",
  "access_type": "application",
  "external_id": "user_12345",
  "external_user_onboarded_at": "2024-11-02T08:15:00Z",
  "name": "Example User"
}

Returns Examples

Response 200

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "created_at": "2026-03-15T10:00:00Z",
  "metadata": {},
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "type": "user_profile",
  "updated_at": "2026-03-15T10:00:00Z",
  "access_type": "application",
  "external_id": "user_12345",
  "external_user_onboarded_at": "2024-11-02T08:15:00Z",
  "name": "Example User"
}