Claude Platform Docs

Update User Profile

$ ant user-profiles update
POST/v1/user_profiles/{user_profile_id}

Update User Profile

Parameters
--user-profile-id: string⁠Path parameter

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

--access-type: optional UserProfileAccessType

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

One of the following:
"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"

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

--external-user-details: optional UserProfileExternalUserDetailsParams { account_status, country, email_hash, 4 more }

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.

--metadata: optional map[string]

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: optional string

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

minLength1
maxLength255
--workspace-id: optional string⁠Header parameter

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
user_profile: object{ type: "user_profile", id, access_type, 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
ant user-profiles update \
  --user-profile-id uprof_011CZkZCu8hGbp5mYRQgUmz9
Returns Examples
Response 200
{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "access_type": "application",
  "created_at": "2026-03-15T10:00:00Z",
  "enforcement_actions": [],
  "enforcement_status": "unrestricted",
  "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"
  },
  "metadata": {},
  "name": "Example User",
  "programs": {
    "cyber": {
      "requirements": null,
      "status": "active",
      "tiers": {
        "a": {
          "status": "inactive"
        },
        "b": {
          "status": "inactive"
        },
        "c": {
          "status": "inactive"
        }
      }
    },
    "efs": null
  },
  "type": "user_profile",
  "updated_at": "2026-03-15T10:00:00Z"
}