Skip to navigation
ReferenceAPI Referenceworkspace-members

Create Invite

Invite a user to the workspace by email. Admin only.

Creates a pending invite and sends an invitation email to the specified address. The invitee does not need to have an existing account — they can sign up after receiving the invite. The invite includes a role (admin, editor, or viewer) that the invitee will receive upon accepting.

Invites expire after 14 days. Only one pending invite per email address per workspace is allowed at a time; re-inviting the same address while a pending invite exists returns 409. Inviting an address that already belongs to an active member also returns 409.

The invitee’s role can be updated before acceptance via PATCH /workspaces/{ws_id}/invites/{invite_id}, or the invite can be cancelled via DELETE /workspaces/{ws_id}/invites/{invite_id}.

Authentication

AuthorizationBearer
Clerk JWT token

Path parameters

ws_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
Email address to invite. Normalized to lowercase. Returns 409 if this address is already an active member or has a pending invite.
roleenumRequired

Role to grant when the invite is accepted: admin, editor, or viewer.

Allowed values:

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error