---
title: "Create invite"
method: POST
path: "/api/v1/workspaces/invites"
tags: ["workspace", "invites"]
---

# Create invite

`POST /api/v1/workspaces/invites`

Create a new invite for the workspace.

    You can create:
    - Email-based invites (send to a specific email)
    - Invite links (with optional restrictions and usage limits)

    **Use cases:**
    - Inviting new members to the workspace
    - Generating invite links for onboarding
    - Automating team invitations

## Request body

- union
  - object
    - `role` 'member' | 'admin', required
    - `email` string, email, required
  - object
    - `role` 'member' | 'admin', required
    - `restrictedDomains` string[]

## Response `200`

This response returns the details of the newly created workspace invite.

- object — This response returns the details of the newly created workspace invite.
  - `id` string, required
  - `created` string, required
  - `type` 'link' | 'email', required
  - `status` 'pending' | 'redeemed' | 'rejected', required
  - `email` string, required
  - `role` 'member' | 'admin', required
  - `resolvedAt` string, required
  - `redeemedBy` string, required
  - `uses` number
  - `restrictedDomains` string[]

## Other responses

- `400` — This response indicates that the request was malformed or contained invalid parameters.
- `401` — This response indicates that the client must authenticate to access the requested resource.
- `403` — This response indicates that the client does not have permission to access the requested resource.

---

[API](https://skmtc.net/excalidraw/apis/excalidraw-api.md) · [All operations](https://skmtc.net/excalidraw/apis/excalidraw-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/excalidraw/excalidraw-api/revisions/c1404d1545ba/schema)