---
title: "Invite a human actor to the workspace."
method: POST
path: "/v1/workspaces/{workspaceId}/invitations"
---

# Invite a human actor to the workspace.

`POST /v1/workspaces/{workspaceId}/invitations`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/invitations`
- Auth: HTTP bearer

## Request body

- object
  - `email` string, email, required
  - `role` 'admin' | 'member' | 'viewer'
  - `mailbox_ids` string[]
  - `send_mode` 'direct' | 'approval_required'
  - `expires_in_hours` integer

## Response `201`

Invitation created.

- object
  - `data` WorkspaceInvitation, required
    - `id` string, uuid, required
    - `code` string, uuid, required
    - `inviteCode` string, uuid
    - `invitedEmail` string, email
    - `workspaceId` string, uuid, required
    - `workspaceName` string, required
    - `role` 'admin' | 'member' | 'viewer', required
    - `accessScope` 'workspace'
    - `status` 'pending' | 'accepted', required
    - `expiresAt` string, date-time, required
    - `notificationSent` boolean

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)