Create Enrollment URL
api/beta/user_profiles/create_enrollment_url
History
api/beta/user_profiles/create_enrollment_url Changed · +15 / -1 lines
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` ## Returns
api/beta/user_profiles/create_enrollment_url Changed · +11 / -16 lines
# Create Enrollment URL ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Create Enrollment URL ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
---- -title: Create Enrollment URL -url: https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url ---- +# Create Enrollment URL -## Create Enrollment URL +**POST** `/v1/user_profiles/{user_profile_id}/enrollment_url` -**post** `/v1/user_profiles/{user_profile_id}/enrollment_url` - Create Enrollment URL -### Path Parameters +## Path parameters - `user_profile_id: string` -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns +## Returns -- `BetaUserProfileEnrollmentURL object { expires_at, type, url }` +- `BetaUserProfileEnrollmentURL object` - `expires_at: string` A timestamp in RFC 3339 format + format: date-time + - `type: "enrollment_url"` Object type. Always `enrollment_url`. - - `"enrollment_url"` - - `url: string` Enrollment URL to send to the end user. Valid until `expires_at`. -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \ -X POST \ -H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {
api/beta/user_profiles/create_enrollment_url Changed · +4 / -2 lines
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \ -X POST \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: user-profiles-2026-03-24' \ + -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ```
api/beta/user_profiles/create_enrollment_url First recorded · 128 lines, first recorded
## Create Enrollment URL ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Enrollment URL
url: https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url
---
## Create Enrollment URL
**post** `/v1/user_profiles/{user_profile_id}/enrollment_url`
Create Enrollment URL
### Path Parameters
- `user_profile_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaUserProfileEnrollmentURL object { expires_at, type, url }`
- `expires_at: string`
A timestamp in RFC 3339 format
- `type: "enrollment_url"`
Object type. Always `enrollment_url`.
- `"enrollment_url"`
- `url: string`
Enrollment URL to send to the end user. Valid until `expires_at`.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"expires_at": "2026-03-15T10:15:00Z",
"type": "enrollment_url",
"url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1"
}
```