---
title: "CreateOrganizationInvite"
method: POST
path: "/gitpod.v1.OrganizationService/CreateOrganizationInvite"
tags: ["gitpod.v1.OrganizationService"]
---

# CreateOrganizationInvite

`POST /gitpod.v1.OrganizationService/CreateOrganizationInvite`

Creates an invite link for joining an organization.
 Any existing OrganizationInvites are invalidated and can no longer be used.

 Use this method to:
 - Generate shareable invite links
 - Manage team growth
 - Control organization access

 ### Examples

 - Create organization invite:

   Generates a new invite link for the organization.

   ```yaml
   organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
   ```

## Request body

- GitpodV1CreateOrganizationInviteRequest
  - `organizationId` string, uuid, required

## Response `200`

Success

- GitpodV1CreateOrganizationInviteResponse
  - `invite` GitpodV1OrganizationInvite, required
    - `inviteId` string, uuid, required — invite_id is the unique identifier of the invite to join the organization. Use JoinOrganization with this ID to join the organization.

## Other responses

- `default` — Error

## Changes

- **2025-02-21** `3655d5ad0ac3` — 1 breaking, 2 info
  - the `invite` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - removed `#/components/schemas/gitpod.v1.OrganizationInvite` from the `invite` response property `allOf` list for the response status `200`
  - added the required property `invite/inviteId` to the response with the `200` status
- **2025-02-18** `cd6a05ae99d2` — 1 warning
  - removed the optional property `detail` from the response with the `default` status
- **2025-02-14** `988164042da1` — 1 breaking, 2 info
  - the request property `organizationId` became required
  - the response property `invite` became required for the status `200`
  - the response property `invite/allOf[subschema #1: OrganizationInvite]/inviteId` became required for the status `200`

[Change history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.OrganizationService/CreateOrganizationInvite/post.md)

---

[API](https://skmtc.dev/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.dev/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/revisions/44d50c2ac284/schema)