Create Invite
api/admin/invites/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/admin/invites/create Changed · +19 / -14 lines
# Create Invite ## Body parameters ## Returns ## Example ### Response (200) ## Create Invite ### Body Parameters ### Returns ### Example #### Response
---- -title: Create Invite -url: https://platform.claude.com/docs/en/api/admin/invites/create ---- +# Create Invite -## Create Invite +**POST** `/v1/organizations/invites` -**post** `/v1/organizations/invites` - For Claude Enterprise organizations, this endpoint's availability is in beta. On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. -### Body Parameters +## Body parameters - `email: string` Email of the User. + format: email + - `role: "billing" or "claude_code_user" or "developer" or 2 more` Role for the invited User.
RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups (beta), and requires the key to carry the `write:rbac_groups` scope. -### Returns + maxItems: 100 -- `Invite object { id, accepted_at, email, 6 more }` +## Returns +- `Invite object` + - `id: string` ID of the Invite.
RFC 3339 datetime string indicating when the Invite was accepted, or null. + format: date-time + - `email: string` Email of the User being invited.
RFC 3339 datetime string indicating when the Invite expires. + format: date-time + - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. + format: date-time + - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (beta, Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
For Invites, this is always `"invite"`. - - `"invite"` + default: invite -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/invites \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
}' ``` -#### Response +### Response (200) ```json {