Delete User Profile

$client->userProfiles->delete(string userProfileID, ?string workspaceID): DeletedUserProfile

DELETE/v1/user_profiles/{user_profile_id}

Delete User Profile

Parameters

userProfileID: string⁠Path

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

workspaceID?: optional string⁠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 DeletedUserProfile { $type = 'user_profile_deleted'; $id; }

"user_profile_deleted" type

Object type. Always user_profile_deleted.

string id

Identifier of the deleted user profile, prefixed uprof_.

Delete User Profile

<?php

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

use Anthropic\Client;

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

$deletedUserProfile = $client->userProfiles->delete(
  'uprof_011CZkZCu8hGbp5mYRQgUmz9',
  workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy',
);

var_dump($deletedUserProfile);

Response 200

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "type": "user_profile_deleted"
}

Returns Examples

Response 200

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "type": "user_profile_deleted"
}