> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # Send an invitation > Invites an email address to an organization (`target_type: org`, `org_id`) or a realm (`target_type: realm`, `realm_id`), with a role (`member` by default; `owner` for organizations only, by an owner; `operator` for realms only). Sending to an address that already has a pending invitation sends it again (`resent: true`). When email is not configured, the reply has the `invite_url` to pass on yourself. Requires a signed-in user token; with `realm_id`, a realm admin with the `realms.members.manage` permission on that realm; with `org_id`, a role with the `org.members.manage` permission in that organization. One of `realm_id` or `org_id` is required. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-invitations.yaml post /v1/invitations/create openapi: 3.0.3 info: title: 'CliqHub API: Invitations' version: 1.0.0 description: >- Invitations bring people into an organization (as member, admin or owner) or a realm (as member, operator or admin). Sending one emails a link; the person previews it and accepts or declines with the token in the link. Someone without an account sets their username and password when accepting, and gets a session token back. An invitation is `pending` until it is accepted, declined, revoked or expires (after 7 days); sending it again to the same address renews it. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Invitations description: >- Invitations bring people into an organization (as member, admin or owner) or a realm (as member, operator or admin). Sending one emails a link; the person previews it and accepts or declines with the token in the link. Someone without an account sets their username and password when accepting, and gets a session token back. An invitation is `pending` until it is accepted, declined, revoked or expires (after 7 days); sending it again to the same address renews it. paths: /v1/invitations/create: post: tags: - Invitations summary: Send an invitation description: >- Invites an email address to an organization (`target_type: org`, `org_id`) or a realm (`target_type: realm`, `realm_id`), with a role (`member` by default; `owner` for organizations only, by an owner; `operator` for realms only). Sending to an address that already has a pending invitation sends it again (`resent: true`). When email is not configured, the reply has the `invite_url` to pass on yourself. Requires a signed-in user token; with `realm_id`, a realm admin with the `realms.members.manage` permission on that realm; with `org_id`, a role with the `org.members.manage` permission in that organization. One of `realm_id` or `org_id` is required. operationId: POST_v1_invitations_create requestBody: required: true content: application/json: schema: type: object properties: target_type: type: string enum: - org - realm description: '`org` or `realm`.' org_id: type: string format: uuid description: '`target_type: org`: the organization.' realm_id: type: string minLength: 1 description: '`target_type: realm`: the realm.' email: type: string minLength: 1 description: The person's email address. role: type: string enum: - owner - admin - member - operator description: >- `member` (default), `admin`, `owner` (organizations) or `operator` (realms). reactivate: type: boolean description: >- Site administrators: restore the deleted account that holds the email. required: - target_type - email examples: org: value: target_type: org org_id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f email: jdoe@acme.example role: member realm: value: target_type: realm realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b email: jdoe@acme.example role: operator responses: '200': description: Success. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: type: object properties: invite_id: type: string status: type: string enum: - pending email: type: string role: type: string expires_at: type: string resent: type: boolean description: A pending invitation existed and was sent again. email_sent: type: boolean invite_url: type: string nullable: true description: The accept link, when the email could not be sent. example: ok: true data: invite_id: 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b status: pending email: jdoe@acme.example role: member expires_at: '2026-10-14T10:00:00Z' resent: false email_sent: true invite_url: null '400': description: '`bad_request`: Neither `realm_id` nor `org_id` was sent.' content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: bad_request: summary: bad_request value: ok: false error: code: bad_request message: realm_id or org_id is required '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: You can see the realm or organization but your role lacks the required permission. `forbidden`: You invited someone as owner without being an owner of the organization. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this forbidden (endpoint): summary: forbidden (endpoint) value: ok: false error: Only an owner of the org can invite an owner code: forbidden '404': description: >- `not_found`: The realm or organization you named does not exist or you cannot see it. `not_found`: The organization or realm does not exist. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found not_found (endpoint): summary: not_found (endpoint) value: ok: false error: Org not found code: not_found '409': description: >- `already_member`: The person is already an active member. `details.user_id` says who. `deleted`: The email belongs to a deleted account (a site administrator can send `reactivate`). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: already_member: summary: already_member value: ok: false error: Already a member. code: already_member deleted: summary: deleted value: ok: false error: jdoe@acme.example belongs to a deleted user code: deleted '422': description: >- `invalid_params`: `email` is missing or invalid, the id for `target_type` is missing, or the role does not fit the target. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'role: operator role is not valid for org invites' code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.