---
title: "Create Invite"
method: POST
path: "/api/workspaces/{workspace_id}/invites"
tags: ["workspaces", "workspaces"]
---

# Create Invite

`POST /api/workspaces/{workspace_id}/invites`

## Request

- Base URL: `https://api.dialogbrain.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.dialogbrain.com/api/workspaces/{workspace_id}/invites`
- Auth: none declared

Invite someone to the workspace.

Requires manage_members permission.
Provide either email (for external users) or user_id (for existing users).

## Path parameters

- `workspace_id` integer, required

## Request body

- InviteCreate: Request to invite someone to a workspace.
  - `email` string, email, nullable
  - `user_id` integer, nullable
  - `role` string
  - `metadata` object, nullable: Optional member metadata, e.g. PMS role and unit IDs

## Response `200`

Successful Response

- InviteResponse: Response for a workspace invite.
  - `id` integer, required
  - `workspace_id` integer, required
  - `email` string, nullable, required
  - `username` string, nullable, required
  - `user_id` integer, nullable, required
  - `role` string, required
  - `token` string, nullable
  - `created_at` string, nullable, required
  - `expires_at` string, nullable, required
  - `invited_by_name` string, nullable, required
  - `invited_by_email` string, nullable, required
  - `email_sent` boolean, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway.md) · [All operations](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/revisions/77bef09a9209?raw)