API · team

Invite a member

POST /api/v2/team/invites

Authorization

Owner/admin user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

Name	Type	Contract
email	string · required	Invitee email
role	enum · optional	admin or operator; default operator

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example

inboxit team invite --data @request.json

JSON body

Save this JSON as request.json for the request above. Replace example values with your own.

Example

{
  "email": "teammate@example.com",
  "role": "operator"
}

Response

HTTP 201. Example values are illustrative; excerpts are marked.

Example

{
  "id": "INVITATION_UUID",
  "mail_status": "pending"
}

Behavior & errors

20 invitations per day per inviter. Existing membership conflicts with 409. Pending invitations persist through signup and require explicit acceptance by the matching verified email. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.