Create invitation
Invites somebody into this workspace.
posthttps://api.integrable.cloud/api/workspace/invitations
- Authentication
- Bearer token
- Retries
- Idempotency-Key
- Body
- application/json
- Version
- 2026-09-03
The role travels in the invitation, not in the acceptance - see invitation_service for why that is the whole security of the flow.
The email is queued inside the same transaction as the invitation row, so the two commit together. An invitation stored without its email is a person who never hears from us; an email sent for a row that rolled back is a link that does not work.
Headers#
Request body#
Responses#
Errors#
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
validation_error· 422 — The payload was well-formed JSON but failed schema validation.unauthenticated· 401 — The request carried no API key, or one the API could not verify.forbidden· 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.idempotency_key_reused· 422 — This `Idempotency-Key` was used before, for a request with a different body.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.
More Workspace endpoints#
Something unclear or missing? Tell us and we’ll fix it.