---
title: "Create an invitation"
method: POST
path: "/{workspace}/invites"
---

# Create an invitation

`POST /{workspace}/invites`

## Request

- Base URL: `https://modeanalytics.com/api`
- URL: `https://modeanalytics.com/api/{workspace}/invites`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/thoughtspot/apis/mode/docs/:workspace/invites/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a `User` and invites `User` to `Workspace`

## Path parameters

- `workspace` string, required

## Request body

- CreateInviteRequestBody
  - `invite` object, required
    - `invitee` object, required
      - `email` string, required
    - `message` string, required

## Response `200`

`WorkspaceInvite` response

- Invite
  - `email` string, required
  - `message` string, required
  - `inviter_id` string, required
  - `invitee_id` string, required
  - `organization_id` string, required
  - `limited` string, required
  - `sent_at` string
  - `resent_at` string
  - `clicked_at` string
  - `accepted_at` string
  - `expires_at` string, required
  - `created_at` string, required
  - `_links` InviteLinks, required
    - `inviter` Link, required
      - `href` string, required
      - `templated` boolean
    - `invitee` Link
      - `href` string, required
      - `templated` boolean
    - `web_self_resend` Link, required
      - `href` string, required
      - `templated` boolean
  - `_embedded` unknown

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: `Membership` not found for `Workspace`

---

[API](https://skmtc.dev/thoughtspot/apis/mode.md) - [All operations](https://skmtc.dev/thoughtspot/apis/mode/llms.txt) - [OpenAPI document](https://skmtc.dev/thoughtspot/apis/mode/revisions/4c694c3fdeb1?raw)