---
title: "Invite someone to the workspace"
method: POST
path: "/members/invitations"
tags: ["member"]
---

# Invite someone to the workspace

`POST /members/invitations`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/members/invitations`
- Auth: HTTP bearer

Emails an invitation that the invited address accepts within seven days. A limited member sees only the items shared with them.

## Request body

- object
  - `email` string, email, required
  - `role` 'admin' | 'member' | 'limited' | 'viewer', required
  - `shared_items` object[]
    - `type` 'round' | 'envelope' | 'document' | 'room' | 'template', required
    - `id` string, required
  - `access_ends_at` string, date

## Response `200`

The result.

- object
  - `id` string, required
  - `email` string, required
  - `role` 'owner' | 'admin' | 'member' | 'limited' | 'viewer', required
  - `shared_items` object[], required
    - `type` 'round' | 'envelope' | 'document' | 'room' | 'template', required
    - `id` string, required
  - `access_ends_at` string, date-time, nullable, required
  - `expires_at` string, date-time, required

## Other responses

- `202`: Called by an agent or an API key, so the call did not run. A person approves it at approval_url; then GET the Location.
- `default`: An RFC 9457 problem.

---

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