Invitations

Create organization invitation

Changed on

Creates or refreshes a pending organization invitation for an email address and sends the invite email. Returns 502 when the invitation row is persisted but the configured email provider failed to send; the client should surface the error and give the user a retry affordance. Returns 402 with billingUrl when the workspace has used its free members: give the user billingUrl to start seat billing, then invite again.

post/v1/invitations

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/invitations
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

emailstring email required
rolestring required
teamIdstring typeid nullable

Den TypeID with 'tem_' prefix and a 26-character base32 suffix.

Response

Existing invitation refreshed successfully.

invitationIdstring typeid required

Den TypeID with 'inv_' prefix and a 26-character base32 suffix.

emailstring email required
rolestring required
expiresAtstring date-time required
inviteTokenstring required

Changes