---
title: "POST /_twake/v1/invite/generate"
method: POST
path: "/_twake/v1/invite/generate"
tags: ["Invitation"]
---

# POST /_twake/v1/invite/generate

`POST /_twake/v1/invite/generate`

## Request

- The document declares no server URL.
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/docs/_twake/v1/invite/generate/post.ts> (a function with typed inputs; its response is checked against the schema)

generates an invitation link

## Request body

- Invitation
  - `contact` string, required: The contact to send the invitation to
  - `medium` string, required: The medium to send the invitation through

## Response `200`

Invitation sent

- object
  - `link` string
  - `id` string

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `500`: Internal Server Error

## Changes

- **2025-04-03** `1665f2b1b716`: 1 info
  - added the optional property `id` to the response with the `200` status
- **2025-04-02** `520730be9be0`: 2 info
  - added the non-success response with the status `500`
  - removed the non-success response with the status `429`
- **2025-03-24** `7d179fbf6f06`: 1 warning
  - removed the request property `room_id`
- **2025-03-20** `206cf6837a40`: 2 breaking, 1 info
  - the request property `contact` became required
  - the request property `medium` became required
  - added the new optional request property `room_id`
- **2025-01-09** `164fc886d7a3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/changes/_twake/v1/invite/generate/post.md)

---

[API](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation.md) - [All operations](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/revisions/3428c7bb5a46?raw)