Claude Platform Docs

Criar URL de ação

POST/v1/user_profiles/{user_profile_id}/action_urls

Criar URL de ação

Path parameters
user_profile_id: string

The ID of the user profile the action is for (uprof_...).

Headers
"anthropic-version": optional string

The version of the Claude API you want to use.

Read more about versioning and our version history here.

"anthropic-workspace-id": optional string

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.

Body
action: UserProfileAction

The action that the person who opens the URL takes.

One of the following:
UserProfileEnrollEndUserAction object{ type: "enroll_end_user" }

The end-user that the profile represents enrolls in a program.

type: "enroll_end_user"
Returns
UserProfileActionURL object{ type: "user_profile_action_url", expires_at, url }

A URL to give to the person who takes the requested action.

type: "user_profile_action_url"

Object type. Always user_profile_action_url.

expires_at: string

When the URL stops working, in RFC 3339 format.

formatdate-time
url: string

The URL to give to the person who takes the action. Anyone who holds it can open it until expires_at.

Criar URL de ação
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/action_urls \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "action": {
            "type": "enroll_end_user"
          }
        }'
Returns Examples
Response 200
{
  "expires_at": "2026-03-15T10:15:00Z",
  "type": "user_profile_action_url",
  "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1"
}