---
title: "Invite somebody by email (owner only)"
method: POST
path: "/workspaces/{id}/invitations"
tags: ["workspaces"]
---

# Invite somebody by email (owner only)

`POST /workspaces/{id}/invitations`

## Request

- Base URL: `https://api.swingfactor.ai/v1`
- URL: `https://api.swingfactor.ai/v1/workspaces/{id}/invitations`
- Auth: HTTP bearer

Only the person signed in with that address can accept it. A pending invitation holds a seat.

## Path parameters

- `id` string, uuid, required

## Headers

- `Idempotency-Key` string

## Request body

- InviteBody
  - `email` string, email, required
  - `role` 'editor' | 'viewer', required

## Response `201`

The invitation.

- Invitation
  - `id` string, uuid, required
  - `containerId` string, uuid, required
  - `email` string, required
  - `token` string, required
  - `role` 'editor' | 'viewer', required
  - `createdAt` string, required
  - `expiresAt` string, required
  - `links` InvitationLinks, required: Relative /v1 URLs to follow.
    - `self` string, required
    - `container` string, required

## Other responses

- `401`: No token, or not a valid one: `unauthorized`.
- `403`: Owner only, or no seat left.

---

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