v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-1759238438.1 KB

Invites

Invite a user to join an organization

Creates an invitation and sends an email to the specified address. Returns FAILED_PRECONDITION if the email belongs to an existing organization member. Idempotency: If a PENDING invitation already exists for this email, the existing invitation is resent with a new token and refreshed expiration. Expired or revoked invitations are ignored - a new invitation is created.

post/v1beta/organizations/{organization_id}/invites

Path parameters

organization_idstring required

Organization to invite the user to. Pattern: org_[0-9a-hjkmnp-tv-z]{26}

Request body

emailstring email required

Email address of the recipient.

idempotency_keystring nullable

Reserved for future use. Currently, idempotency is based on email matching: if a PENDING invitation exists for the same email in this organization, that invitation is resent rather than creating a duplicate.

messagestring nullable

Optional custom message from the sender (max 2000 bytes to support ~500 multibyte characters).

Response

Success

Example response

{
  "invite": {
    "accepted_by": {
      "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
    },
    "email": "dwight@dundermifflin.com",
    "id": "inv_01h2xcejqtf2nbrexx3vqjhp41",
    "organization_id": "org_01h2xcejqtf2nbrexx3vqjhp41",
    "sender": {
      "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
    }
  }
}