Invite a user to your workspace

POST

///api/v1/users/invite

Send an invitation email to a new workspace member.

Returns 201 on first invite, 200 on resend (same email, pending invite).
409 if the email already belongs to a user in this workspace.
404 if profile_id (or legacy role_id) is provided but not found in this tenant.

Send an invitation email to a new workspace member. - Returns **201** on first invite, **200** on resend (same email, pending invite). - **409** if the email already belongs to a user in this workspace. - **404** if `profile_id` (or legacy `role_id`) is provided but not found in this tenant.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

emailstringRequiredformat: "email"

profile_idstring or nullOptionalformat: "uuid"

role_idstring or nullOptionalformat: "uuid"

Response

Successful Response

idstringformat: "uuid"

emailstring

invited_bystring or nullformat: "uuid"

expires_atdatetime

accepted_atdatetime or null

revoked_atdatetime or null

created_atdatetime

profile_idstring or nullOptionalformat: "uuid"

role_idstring or nullOptionalformat: "uuid"

Errors

422

Unprocessable Entity Error

$	curl -X POST /api/v1/users/invite \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "string"
>	}'

1	{
2	"id": "string",
3	"email": "string",
4	"invited_by": "string",
5	"expires_at": "2024-01-15T09:30:00Z",
6	"accepted_at": "2024-01-15T09:30:00Z",
7	"revoked_at": "2024-01-15T09:30:00Z",
8	"created_at": "2024-01-15T09:30:00Z",
9	"profile_id": "string",
10	"role_id": "string"
11	}