Create Invite | Onepin

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}.

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.

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

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

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}.

$	curl -X POST https://api.onepin.ai/api/v1/workspaces/ws_id/invites \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "jane.doe@example.com",
>	"role": "admin"
>	}'

1	{
2	"data": {
3	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"email": "jane.doe@example.com",
5	"role": "admin",
6	"status": "pending",
7	"expires_at": "2024-07-01T09:30:00Z",
8	"invited_by": "1c9d4f8e-2b7a-4f3e-9a1d-5f6e7b8c9d0a",
9	"created_at": "2024-06-17T09:30:00Z"
10	},
11	"meta": {
12	"request_id": "req_7f8e9d6c5b4a3e2f1d0c",
13	"timestamp": "2024-06-17T09:30:00Z"
14	}
15	}