Create Invite | OnePin

Invite a user to the workspace via email.

POD-301: gated by seats plan limit on the workspace owner’s plan. Active members + pending invites both count against the cap.

AuthorizationBearer

Clerk JWT token

ws_idstringRequiredformat: "uuid"

This endpoint expects an object.

emailstringRequiredformat: "email"

roleenumRequired

Allowed values:

Successful Response

dataobject

metaobject

422

Unprocessable Entity Error

$	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-01-15T09:30:00Z",
8	"invited_by": "1c9d4f8e-2b7a-4f3a-9d2e-5f6a7b8c9d0e",
9	"created_at": "2024-01-15T09:30:00Z"
10	},
11	"meta": {
12	"request_id": "7b9f8e6d-4c3a-11ec-81d3-0242ac130003",
13	"timestamp": "2024-01-15T09:30:00Z"
14	}
15	}

$	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-01-15T09:30:00Z",
8	"invited_by": "1c9d4f8e-2b7a-4f3a-9d2e-5f6a7b8c9d0e",
9	"created_at": "2024-01-15T09:30:00Z"
10	},
11	"meta": {
12	"request_id": "7b9f8e6d-4c3a-11ec-81d3-0242ac130003",
13	"timestamp": "2024-01-15T09:30:00Z"
14	}
15	}