Plum / developers
REST APIWorkspaces

Invite someone to a workspace

Invites an email address to a shared workspace as `member` (default) or `admin` and queues an email with a link that expires in 7 days. The email is sent after the invite is created; the response does not report delivery. An account creates at most 20 invites an hour, a workspace at most 50 a day (revoked invites count), and a workspace holds at most 100 pending invites. Admins and owners; requires `workspace:members`. Needs workspace sharing for your account; otherwise 403 `WORKSPACE_SHARING_REQUIRED`.

POST/workspaces/{id}/invites

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/invites" \  -H "X-API-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",    "email": "string",    "role": "string",    "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777",    "created_at": "2019-08-24T14:15:22Z",    "sent_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z"  }}

List pending invitations GET

Lists pending invites, newest first, including expired ones that can be resent. Admins and owners; requires `workspace:members`. Returns every pending invite; `cursor` is always null. Needs workspace sharing for your account; otherwise 403 `WORKSPACE_SHARING_REQUIRED`.

Revoke an invitation DELETE

Revokes a pending invite; its link stops working. Admins and owners; requires `workspace:members`. Needs workspace sharing for your account; otherwise 403 `WORKSPACE_SHARING_REQUIRED`.