API Docs / Operations / Team / Create Tenant Invitation

Create Tenant Invitation

POST /tenants/{tenant}/invitations

Invites an email address to join the tenant (Admin access unless another role is given) and sends the invitation email. It expires after seven days.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

Request Body*

{
  "email": "user@example.com",
  "role": "None",
  "message": "string"
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json