---
title: Create Invite
url: https://platform.claude.com/docs/en/api/java/organization/invites/create
---

# Create Invite

`OrganizationInvite organization().invites().create(params, requestOptions = RequestOptions.none())`

**POST** `/v1/organizations/invites`

Invite a user to join the organization by email.

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.

## Parameters

- `InviteCreateParams params`

  - `String email`

    Email of the User.

    format: email

  - `Role role`

    Role for the invited User.

    The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`.

    - `BILLING("billing")`

    - `CLAUDE_CODE_USER("claude_code_user")`

    - `DEVELOPER("developer")`

    - `MANAGED("managed")`

    - `USER("user")`

  - `Optional<List<String>> rbacGroupIds`

    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, and requires the key to carry the `write:rbac_groups` scope.

    maxItems: 100

## Returns

- `class OrganizationInvite`

  - `JsonValue type = "invite"`

    Object type.

    For Invites, this is always `"invite"`.

  - `String id`

    ID of the Invite.

  - `Optional<LocalDateTime> acceptedAt`

    RFC 3339 datetime string indicating when the Invite was accepted, or null.

    format: date-time

  - `String email`

    Email of the User being invited.

  - `LocalDateTime expiresAt`

    RFC 3339 datetime string indicating when the Invite expires.

    format: date-time

  - `LocalDateTime invitedAt`

    RFC 3339 datetime string indicating when the Invite was created.

    format: date-time

  - `List<String> rbacGroupIds`

    RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.

  - `OrganizationRole role`

    Organization role of the User.

    - `ADMIN("admin")`

    - `BILLING("billing")`

    - `CLAUDE_CODE_USER("claude_code_user")`

    - `DEVELOPER("developer")`

    - `MANAGED("managed")`

    - `MEMBERSHIP_ADMIN("membership_admin")`

    - `OWNER("owner")`

    - `PRIMARY_OWNER("primary_owner")`

    - `USER("user")`

  - `Status status`

    Status of the Invite.

    - `ACCEPTED("accepted")`

    - `DELETED("deleted")`

    - `EXPIRED("expired")`

    - `PENDING("pending")`

## Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.invites.InviteCreateParams;
import com.anthropic.models.organization.invites.OrganizationInvite;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        InviteCreateParams params = InviteCreateParams.builder()
            .email("user@emaildomain.com")
            .role(InviteCreateParams.Role.USER)
            .build();
        OrganizationInvite organizationInvite = client.organization().invites().create(params);
    }
}
```

### Response (200)

```json
{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "accepted_at": "2019-12-27T18:11:19.117Z",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "rbac_group_ids": [
    "string"
  ],
  "role": "admin",
  "status": "pending",
  "type": "invite"
}
```