Skip to content
Documentation/API reference
API · invitations

Respond to invitation

POST /api/v2/invitations/{id}

Authorization

Authenticated 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.

NameTypeContract
idpath · requiredResource UUID
actionenum · requiredaccept or decline

Request

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

Example
inboxit invitations respond --id RESOURCE_UUID --data @request.json

JSON body

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

Example
{
  "action": "accept"
}

Response

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

Example
{
  "workspace_id": "WORKSPACE_UUID",
  "status": "accepted"
}

Behavior & errors

Requires the matching verified email. Acceptance is idempotent for an already accepted invitation. 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.