> ## Documentation Index
> Fetch the complete documentation index at: https://dc9c767-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://dc9c767-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://dc9c767-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://dc9c767-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Invite teammates (/docs/api/account/invitations-send)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 1124 · updated: 2026-11-16 -->
Related: [Create a checkout link](/docs/api/account/billing-create-checkout-link.md), [Create workspace](/docs/api/account/companies-create.md), [Send feedback](/docs/api/account/feedback-send.md), [Get the Google connect link](/docs/api/account/google-get-connect-link.md), [Complete onboarding](/docs/api/account/onboarding-complete.md), [Get onboarding state](/docs/api/account/onboarding-get-state.md)

> Invites up to 50 people by email to the workspace, each with a role; each gets an email to accept.

`POST https://prod-backend.productmetrics.io/api/public/v1/companies/{companyId}/invitations`

**Scope** `write` · **Access** Changes data · **Operation id** `invitations.send`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)). Set `$COMPANY_ID` first.



**productmetrics CLI:**

```bash
productmetrics invitations send \
  --company-id $COMPANY_ID \
  --invitees '[{"email":"owner@example.com","role":"admin"}]' \
  --json
```

**curl:**

```bash
curl -X POST "https://prod-backend.productmetrics.io/api/public/v1/companies/$COMPANY_ID/invitations" \
  -H "Authorization: Bearer $PM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"invitees":[{"email":"owner@example.com","role":"admin"}]}'
```

## Response

API response (200):

```json
{
  "data": {
    "success": true,
    "results": [
      {
        "email": "owner@example.com",
        "success": true,
        "error": "Example message.",
        "invitationId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "emailSent": true
      }
    ],
    "summary": {
      "total": 108,
      "successful": 12.5,
      "failed": 12.5
    }
  },
  "request_id": "req_01JDV3C456S1CDDZD3DF55YSK5"
}
```

**CLI output:** `productmetrics invitations send --json` prints `{ "ok": true, "data": …, "request_id": "…" }` with the same `data`.

## Before you call

Needs admin access to the workspace. Answers per address whether the invitation was sent or why not (already a member, already invited). Confirm the addresses and roles with the person first.

## Path parameters

| Name        | Type          | Description                                                                                                          |
| ----------- | ------------- | -------------------------------------------------------------------------------------------------------------------- |
| `companyId` | string (uuid) | Your workspace id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/properties-list) (`company_id`). |

## Body

| Name               | Type            | Required | Description                                                                   |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------- |
| `invitees`         | array of object | Yes      | The people to invite, up to 50, each with an email and a role. 1 to 50 items. |
| `invitees[].email` | string (email)  | Yes      | The email address the invitation goes to.                                     |
| `invitees[].role`  | enum            | Yes      | Their role in the workspace. One of `admin`, `editor`, `viewer`.              |

## Errors

A failure answers with its HTTP status and `{ error: { code, message, details? }, request_id }`. Branch on `code` (stable, lower_snake); show `message` to the person. The CLI prints the same `error` with `"ok": false`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the write scope; connect again and allow it.",
    "details": {
      "required_scope": "write"
    }
  },
  "request_id": "req_01JKDYMSY9A3WXJAN3HFVZPRFP"
}
```

| Status | Code                 | When                                                                                                                      |
| ------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 400    | `invalid_request`    | A path, query or body value does not match this page. `details.issues` lists each `location`, `path` and `message`.       |
| 401    | `invalid_token`      | The token is missing, expired or revoked: sign in again (`productmetrics login`). The `WWW-Authenticate` header says why. |
| 403    | `insufficient_scope` | The token lacks the `write` scope (`details.required_scope`): sign in again and allow it.                                 |
| 404    | `not_found`          | An id in the path does not exist, or the signed-in person cannot open it.                                                 |
| 429    | `rate_limited`       | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Account and onboarding operations](/docs/api/account)
