Create User Profile
api/beta/user_profiles/create
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/beta/user_profiles/create Changed · +20 / -19 lines
# Create User Profile ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Create User Profile ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
---- -title: Create User Profile -url: https://platform.claude.com/docs/en/api/beta/user_profiles/create ---- +# Create User Profile -## Create User Profile +**POST** `/v1/user_profiles` -**post** `/v1/user_profiles` - Create User Profile -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
- `"mid-conversation-tool-changes-2026-07-01"` -### Body Parameters +## Body parameters - `access_type: optional "application" or "passthrough"`
Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. + minLength: 1, maxLength: 255 + - `metadata: optional map[string]` Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.
Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a resold-to company (`relationship` `resold` / `access_type` `passthrough`), that company's name where known. Maximum 255 characters. + minLength: 1, maxLength: 255 + - `relationship: optional "external" or "resold" or "internal"` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"internal"` -### Returns +## Returns -- `BetaUserProfile object { id, created_at, metadata, 7 more }` +- `BetaUserProfile object` - `id: string`
A timestamp in RFC 3339 format + format: date-time + - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
Object type. Always `user_profile`. - - `"user_profile"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `access_type: optional "application" or "passthrough"` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company.
- `"internal"` -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/user_profiles \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
}' ``` -#### Response +### Response (200) ```json {