Invite User

Invites a new user to your workspace. Allegrow sends the invite email, the invitation consumes a seat, and the invitee appears on the users list as status: invited until they sign up.

The API key must belong to a user whose role has the invite-members permission in your workspace — the same rule the in-app invite flow enforces. Re-inviting an email that already has a pending invite replaces it with a fresh invite code and a new 30-day expiry; inviting an email that already belongs to an active user is rejected with a 409.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Invites a new user to your workspace. Allegrow sends the invite email, the invitation consumes a seat, and the invitee appears on List Users as status: invited until they sign up.

The API key must belong to a user whose role can invite members — the same rule the in-app invite flow enforces. If it can't, you get a 403.

Re-inviting an email with a pending invite replaces it: a fresh invite email goes out with a new code and a new 30-day expiry. Inviting an email that already belongs to an active user returns a 409, as does running out of seats — the error message tells you which.

Body Params
string
required

The invitee's email address.

string
length ≤ 255

Used to personalise the invite email.

string
length ≤ 255
string
enum
Defaults to member

The role the invitee will hold once they sign up.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json