The whole hunk
from line 12, old and new numbered
/
lines
from line 12
1212
1313 - `string`
1414
15 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more`
15 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1616
1717 - `"message-batches-2024-09-24"`
1818
from line 96
9696
9797 - `"ce-user-management-2026-07-13"`
9898
99 - `"mid-conversation-output-config-2026-07-01"`
100
101 - `"thinking-binding-controls-2026-08-01"`
102
103 - `"mid-conversation-system-clear-at-2026-08-21"`
104
99105## Body parameters
100106
101107- `access_type: optional "application" or "passthrough"`
from line 118
112118
113119 minLength: 1, maxLength: 255
114120
121- `external_user_onboarded_at: optional string`
122
123 A timestamp in RFC 3339 format
124
125 format: date-time
126
115127- `metadata: optional map[string]`
116128
117129 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.
from line 130
118130
119131- `name: optional string or null`
120132
121 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.
133 Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters.
122134
123135 minLength: 1, maxLength: 255
124136
125- `relationship: optional "external" or "resold" or "internal"`
126
127 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.
128
129 - `"external"`
130
131 - `"resold"`
132
133 - `"internal"`
134
135137## Returns
136138
137139- `BetaUserProfile object`
from line 188
186188
187189 Platform's own identifier for this user. Not enforced unique.
188190
189 - `name: optional string or null`
191 - `external_user_onboarded_at: optional string or null`
190192
191 Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name.
193 A timestamp in RFC 3339 format
192194
193 - `relationship: optional "external" or "resold" or "internal"`
195 format: date-time
194196
195 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.
197 - `name: optional string or null`
196198
197 - `"external"`
199 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.
198200
199 - `"resold"`
200
201 - `"internal"`
202
203201## Example
204202
205203```bash
from line 208
210208 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
211209 -d '{
212210 "external_id": "user_12345",
211 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
213212 "metadata": {}
214213 }'
215214```
from line 229
230229 "updated_at": "2026-03-15T10:00:00Z",
231230 "access_type": "application",
232231 "external_id": "user_12345",
233 "name": "Example User",
234 "relationship": "external"
232 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
233 "name": "Example User"
235234}
236235```
237236