Send invitiation to join workspace

Testing

POST

/v2/workspaces/invitations

Send invitation to a new member to join workspace

Request

Header Params

Body Params application/jsonRequired

Example

{
    "email": "newuser@example.com",
    "role": "EDITOR",
    "workspaceId": "workspace_uuid"
  }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zapmail.ai/api/v2/workspaces/invitations' \
--header 'x-auth-zapmail: YOUR_API_KEY' \
--header 'x-workspace-key: workspace_id' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "newuser@example.com",
    "role": "EDITOR",
    "workspaceId": "workspace_uuid"
  }'

Responses

🟢200Success

application/json

Body

Example

{
  "status": 200,
  "message": "Invitation sent successfully",
  "data": {
    "id": "invitation_uuid",
    "inviteeEmail": "newuser@example.com",
    "role": "EDITOR",
    "status": "PENDING",
    "expiresAt": "2026-01-17T10:30:00Z"
  }
}

🟠409Conflict

Modified at 2026-01-15 09:33:55

Revoke User Access

List all invitations