---
title: "Create an invitation"
method: POST
path: "/invitations"
tags: ["Invitations"]
---

# Create an invitation

`POST /invitations`

## Request

- Base URL: `https://api.xfa.tech`
- URL: `https://api.xfa.tech/invitations`
- Auth: HTTP bearer

## Request body

- InvitationRequest
  - `organization_id` string, required: ID of the organization
  - `email` string, required: Email of the user
  - `send_email` boolean: Whether to send an email invitation. Defaults to true.
  - `send_slack_message` boolean: Whether to send a Slack invitation message. Defaults to false.
  - `send_teams_message` boolean: Whether to send a Microsoft Teams invitation message. Defaults to false.

## Response `200`

Invitation created

- InvitationResponse
  - `invitation_token` string, required: Invitation token
  - `invitation_url` string, required: url to invitation
  - `quota` ManualAwarenessQuota: Manual-awareness message counter reported after a send. A limit of 0 means unlimited.
    - `used` integer, required: Number of manual-awareness messages used in the current period
    - `limit` integer, required: Manual-awareness message limit for the current period. 0 means unlimited.
    - `remaining` integer, required: Number of manual-awareness messages remaining in the current period
    - `period` 'trial' | 'month', required: Period the quota applies to
  - `invited_by` string: Authenticated inviter email or stable automated origin identifier

---

[API](https://skmtc.dev/xfa/apis/xfa-api.md) · [All operations](https://skmtc.dev/xfa/apis/xfa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xfa/apis/xfa-api/revisions/1a1be0e8972b?raw)