a13nDocs
API referenceTenancy

Create Workspace Invitation

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

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

workspace_id*Workspace Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/workspaces/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "role": "string"  }'
{  "delivery": "queued",  "invitation": {    "accepted_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "email": "string",    "expires_at": "2019-08-24T14:15:22Z",    "id": "string",    "invited_by_id": "string",    "organization_id": "string",    "principal_id": "string",    "revoked_at": "2019-08-24T14:15:22Z",    "role": "string",    "updated_at": "2019-08-24T14:15:22Z",    "version": 0,    "workspace_id": "string"  },  "invitation_url": "string"}