---
title: Invite members
description: Invites one or more email addresses with the same role.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# Invite members

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

Invites one or more email addresses with the same role. Requires an admin key. Send between 1 and 50 addresses. Each address returns its own outcome.

## Authentication

Send `Authorization: Bearer <SPARK_API_KEY>`. Read the key from the
SPARK_API_KEY environment variable. Never print it.

## Path parameters

- `workspaceId` (string) — The workspace id.

## Request body

- `emails` (string[]) — Email addresses to invite. Send 1 to 50 addresses.
- `role` (string) — Role granted when the person accepts. One of: viewer, editor, admin.

## Example request

```bash
curl \
  --url "https://api.beta.graphon.ai/v1/workspaces/wspQ7WsH2Np5L/invitations" \
  --header "Authorization: Bearer $SPARK_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"emails":["grace@example.com"],"role":"editor"}'
```

## Example response

```json
{
  "results": [
    {
      "email": "grace@example.com",
      "outcome": "created",
      "invitation": {
        "id": "invC3d4E5f6G7",
        "workspaceId": "wspQ7WsH2Np5L",
        "email": "grace@example.com",
        "role": "editor",
        "state": "pending",
        "delivery": "queued",
        "expiresAt": "2026-09-21T18:00:00.000Z",
        "revision": 1
      }
    }
  ]
}
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.