Create Invite

post/v1/organizations/invites

Create Invite

Body ParametersExpand Collapse

email: string

Email of the User.

formatemail

role: "user" or "developer" or "billing" or "claude_code_user"

Role for the invited User. Cannot be "admin".

Accepts one of the following:

"user"

"developer"

"billing"

"claude_code_user"

ReturnsExpand Collapse

Invite = object { id, email, expires_at, 4 more }

id: string

ID of the Invite.

email: string

Email of the User being invited.

expires_at: string

RFC 3339 datetime string indicating when the Invite expires.

formatdate-time

invited_at: string

RFC 3339 datetime string indicating when the Invite was created.

formatdate-time

role: "user" or "developer" or "billing" or 2 more

Organization role of the User.

Accepts one of the following:

"user"

"developer"

"billing"

"admin"

"claude_code_user"

status: "accepted" or "expired" or "deleted" or "pending"

Status of the Invite.

Accepts one of the following:

"accepted"

"expired"

"deleted"

"pending"

type: "invite"

Object type.

For Invites, this is always "invite".

Accepts one of the following:

"invite"

Create Invite

cURL

curl https://api.anthropic.com/v1/organizations/invites \
    -H 'Content-Type: application/json' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "email": "[email protected]",
          "role": "user"
        }'

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "[email protected]",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}

Returns Examples

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "[email protected]",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}

Create Invite

post/v1/organizations/invites

Create Invite

Body ParametersExpand Collapse

email: string

Email of the User.

formatemail

role: "user" or "developer" or "billing" or "claude_code_user"

Role for the invited User. Cannot be "admin".

Accepts one of the following:

"user"

"developer"

"billing"

"claude_code_user"

ReturnsExpand Collapse

Invite = object { id, email, expires_at, 4 more }

id: string

ID of the Invite.

email: string

Email of the User being invited.

expires_at: string

RFC 3339 datetime string indicating when the Invite expires.

formatdate-time

invited_at: string

RFC 3339 datetime string indicating when the Invite was created.

formatdate-time

role: "user" or "developer" or "billing" or 2 more

Organization role of the User.

Accepts one of the following:

"user"

"developer"

"billing"

"admin"

"claude_code_user"

status: "accepted" or "expired" or "deleted" or "pending"

Status of the Invite.

Accepts one of the following:

"accepted"

"expired"

"deleted"

"pending"

type: "invite"

Object type.

For Invites, this is always "invite".

Accepts one of the following:

"invite"

Create Invite

cURL

curl https://api.anthropic.com/v1/organizations/invites \
    -H 'Content-Type: application/json' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "email": "[email protected]",
          "role": "user"
        }'

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "[email protected]",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}

Returns Examples

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "[email protected]",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}

Create Invite

Body ParametersExpand Collapse

ReturnsExpand Collapse

Create Invite

Returns Examples

Products

Features

Models

Solutions

Claude Developer Platform

Learn

Company

Help and security

Terms and policies

Create Invite

Body ParametersExpand Collapse

ReturnsExpand Collapse

Create Invite

Returns Examples

Products

Features

Models

Solutions

Claude Developer Platform

Learn

Company

Help and security

Terms and policies