Invite user to workspace

Creates or refreshes a pending workspace invitation for an email address. This endpoint can be called by a session member or a workspace-scoped API key with write access.

POST/api/v1/workspaces/{workspaceHandle}/invitations

Creates or refreshes a pending workspace invitation for an email address. This endpoint can be called by a session member or a workspace-scoped API key with write access.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*nonEmptyString

a non empty string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://loading/api/v1/workspaces/{workspaceHandle}/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "future-member@example.com"  }'

{
  "workspace": {
    "handle": "acme-growth-team",
    "name": "Acme Growth Team"
  },
  "invitation": {
    "id": "9c1742b9-3d0b-4c48-8a6d-5f0dd4a2da7c",
    "email": "future-member@example.com",
    "acceptedAt": null
  }
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have workspaces.write permission.",
  "details": {
    "requiredPermission": "workspaces.write"
  }
}

{
  "code": "not_found",
  "message": "The requested resource was not found."
}

{
  "code": "conflict",
  "message": "The requested resource already exists."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Invite user to workspace

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`