Sign in
Organizations

Create organization invite

Changed on

Create a new invitation for an organization. An invitation email will be sent to the provided email address if send_email is set to true.

Invitations cannot be created for organizations that are managed by directory sync; user and role changes for those organizations must be made in the upstream identity provider.

Roles that require an explicit assignment permission cannot be granted to an invitee unless the caller (or the user the token represents) holds that permission. On Kinde-hosted plans, roles outside owner/admin additionally require the extended_roles entitlement.

Per-organization rate limits apply: a maximum number of invitations may be created per rolling 24 hour window, and a maximum number of active (non-accepted, non-revoked) invitations may exist at any time. Requests that exceed either limit are rejected.

<div> <code>create:organization_invites</code> </div>
post/api/v1/organization/{org_code}/invites

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/organization/{org_code}/invites
  • Auth: HTTP bearer

Path parameters

org_codestring required
Example:org_1ccfb819462

The organization's code.

Request body

emailstring required

The email address of the user to invite. Maximum 254 characters.

first_namestring nullable

The first name of the user to invite. Maximum 64 characters.

last_namestring nullable

The last name of the user to invite. Maximum 64 characters.

rolesstring[] required

Array of role keys to assign to the user.

send_emailboolean

Whether to send an invitation email to the user. Defaults to false.

Example request

{
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "roles": [
    "admin",
    "manager"
  ]
}

Response

Invitation successfully created.

codestring

Response code.

messagestring

Response message.

Example response

{
  "code": "INVITATION_CREATED",
  "message": "Invitation created",
  "invite": {
    "id": "inv_abc123def456",
    "code": "inv_abc123def456",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "created_on": "2024-11-18T13:32:03+11",
    "is_sent": true,
    "roles": [
      {
        "key": "admin",
        "name": "Administrator"
      },
      {
        "key": "manager",
        "name": "Manager"
      }
    ],
    "invite_link": "https://example.kinde.com/team_invitation?code=inv_abc123def456"
  }
}

Changes