Invite members

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

POST/v1/workspaces/{workspaceId}/invitations

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

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

Request

Loading your session…

Response

JSON

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

Path parameters

workspaceIdstring

The workspace id.

Request body

emailsstring[]

Email addresses to invite. Send 1 to 50 addresses.

rolestring

Role granted when the person accepts. One of: viewer, editor, admin.

Was this page helpful?

View as Markdown