Invite a user by email

boardGrants is optional and only honoured for role: "member" invitations - admin invitations auto-see every board. Grants are persisted alongside the invitation and applied atomically when the invitee accepts.

When the email already belongs to a verified account, the invite is accepted on the spot and consumed is true (the person is now a member). An unverified account leaves the invite pending until the address is confirmed.

post/invitations

Request

  • Base URL: https://craaft.io/api/v1
  • URL: https://craaft.io/api/v1/invitations
  • Auth: HTTP bearer

Request body

emailstring email required
role'admin' | 'member' required

Response

Created. The invitation is wrapped, not returned bare.

consumedboolean required

True when an existing verified account was added immediately

Changes

No recorded changes to this operation across all 2 revisions of this API.