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. With practice, the invitation is to the tenant's whole practice: accepting it reaches every organisation the practice runs (400 for a tenant in no practice, 409 for a practice managed in Sodium).

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",
  "practice": false
}

Responses

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