Invite a teammate | Pivolio Docs

Invites an email address to join the active workspace with the given role and sends them an invitation email.

X-Workspace-Idstring

API Key authentication via header

This endpoint expects an object.

emailstringRequiredformat: "email"

roleenumRequired

A member’s role within a workspace (org). Owner is unique-required.

Successful Response

idstringformat: "uuid"

emailstring

roleenum

A member’s role within a workspace (org). Owner is unique-required.

statusenum

Lifecycle state of a workspace invitation.

invited_by_emailstring

created_atdatetime

expires_atdatetime

accept_urlstring

422

Unprocessable Entity Error

$	curl -X POST https://host.com/invitations \
>	-H "X-Workspace-Id: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "string",
>	"role": "owner"
>	}'