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

The ID of the user profile to update (uprof_...).

AccessType? accessType

If present, replaces the stored access type. Omit to leave unchanged.

Application("application")

The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.

Passthrough("passthrough")

The user profile represents a company that the platform resells Claude access to.

string? externalID

If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Legacy field, accepted only under the user-profiles-2026-03-24 and user-profiles-2026-08-18 beta headers; without one of them, send external_user_details.reference_id.

minLength1

maxLength255

BetaUserProfileExternalUserDetailsParams externalUserDetails

Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and null is rejected. Not accepted under the legacy user-profiles-2026-03-24 and user-profiles-2026-08-18 beta headers.

DateTimeOffset externalUserOnboardedAt

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. Legacy field, accepted only under the user-profiles-2026-08-18 beta header; without a legacy header, send external_user_details.onboarded_at.

formatdate-time

IReadOnlyDictionary<string, string> metadata

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

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

minLength1

maxLength255

IReadOnlyList<AnthropicBeta> betas⁠Header

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")

UserProfiles2026_09_04("user-profiles-2026-09-04")

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")

Compact2026_09_04("compact-2026-09-04")

InlineTools2026_09_15("inline-tools-2026-09-15")

McpClient2026_09_15("mcp-client-2026-09-15")

CEPlugins2026_09_01("ce-plugins-2026-09-01")

SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")

TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")

Webhooks2026_10_07("webhooks-2026-10-07")

MessageThreads2026_08_12("message-threads-2026-08-12")

AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")

ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")

string workspaceID⁠Header

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns

class BetaUserProfile { Type = "user_profile"; ID; CreatedAt; /* 8 more */ }

A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.

A Messages, Message Batches or token counting request can send a profile's id in the anthropic-user-profile-id header to attribute the request to that entity.

Update User Profile

using System;
using Anthropic.Models.Beta.UserProfiles;

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": {},
  "name": "Example User",
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "type": "user_profile",
  "updated_at": "2026-03-15T10:00:00Z",
  "access_type": "application",
  "external_id": "user_12345",
  "external_user_details": {
    "account_status": "active",
    "country": "US",
    "email_hash": null,
    "entity_type": "business",
    "name_hash": null,
    "onboarded_at": "2024-11-02T08:15:00Z",
    "reference_id": "user_12345"
  },
  "external_user_onboarded_at": "2024-11-02T08:15:00Z"
}

Returns Examples

Response 200

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "created_at": "2026-03-15T10:00:00Z",
  "metadata": {},
  "name": "Example User",
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "type": "user_profile",
  "updated_at": "2026-03-15T10:00:00Z",
  "access_type": "application",
  "external_id": "user_12345",
  "external_user_details": {
    "account_status": "active",
    "country": "US",
    "email_hash": null,
    "entity_type": "business",
    "name_hash": null,
    "onboarded_at": "2024-11-02T08:15:00Z",
    "reference_id": "user_12345"
  },
  "external_user_onboarded_at": "2024-11-02T08:15:00Z"
}