--- title: Update User Profile url: https://platform.claude.com/docs/en/api/php/user_profiles/update --- # Update User Profile `$client->userProfiles->update(string userProfileID, ?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array metadata, ?string name, ?string workspaceID): UserProfile` **POST** `/v1/user_profiles/{user_profile_id}` Update User Profile ## Parameters - `userProfileID: string` (path parameter) The ID of the user profile to update (`uprof_...`). - `accessType?: optional UserProfileAccessType` If present, replaces the stored access type. Omit to leave unchanged. - `externalUserDetails?: optional UserProfileExternalUserDetailsParams` 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 array` 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. - `workspaceID?: 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 - `class UserProfile` - `"user_profile" type` Object type. Always `user_profile`. - `string id` Unique identifier for this user profile, prefixed `uprof_`. - `UserProfileAccessType accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `\Datetime createdAt` When this user profile was created, in RFC 3339 format. - `list enforcementActions` The enforcement actions open on this profile; empty when none is open. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileEnforcementStatus enforcementStatus` Anthropic's enforcement status of this profile, from its open enforcement actions and any identity check under review, by the first rule that applies: `banned` while any open action is a `ban`; `pending` while a restriction that an identity check can clear is open, the end user has submitted that check, Anthropic's review of it has not ended, and no open action's `reason` is `account_compromise`; `restricted` while any action is open; `unrestricted` while none is. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileExternalUserDetails externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `array metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `?string name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `UserProfilePrograms programs` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `\Datetime updatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. ## Example ```php userProfiles->update( 'uprof_011CZkZCu8hGbp5mYRQgUmz9', accessType: UserProfileAccessType::APPLICATION, externalUserDetails: [ 'accountStatus' => UserProfileExternalUserAccountStatus::SUSPENDED, 'country' => 'SE', 'emailHash' => 'x', 'entityType' => UserProfileExternalUserEntityType::INDIVIDUAL, 'nameHash' => 'x', 'onboardedAt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), 'referenceID' => 'x', ], metadata: ['foo' => 'string'], name: 'x', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($userProfile); ``` ### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "enforcement_actions": [ { "id": "enac_011CZkZCu8hGbp5mYRQgUmz9", "action": "verify", "expires_at": null, "opened_at": "2026-10-02T19:30:00Z", "reason": "fraud_or_abuse", "type": "restriction" } ], "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": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ```