Claude Platform Docs

Perbarui Profil Pengguna

$client->userProfiles->update(string userProfileID, ?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array<string,string> metadata, ?string name, ?string workspaceID): UserProfile
POST/v1/user_profiles/{user_profile_id}

Perbarui Profil Pengguna

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<string,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.

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 { $type = 'user_profile'; $id; $accessType; /* 8 more */ }
Perbarui Profil Pengguna
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;
use Anthropic\UserProfiles\UserProfileAccessType;
use Anthropic\UserProfiles\UserProfileExternalUserAccountStatus;
use Anthropic\UserProfiles\UserProfileExternalUserEntityType;

$client = new Client(apiKey: 'my-anthropic-api-key');

$userProfile = $client->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);
Returns Examples
Response 200
{
  "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"
}