Pause a tenant
pause_tenantPause a tenant.
Stops all sending for the tenant. Sends return 403 sending_paused; emails already queued fail. The body is optional.
Requires a full_access API key. API: POST /tenants/{ref}/pause (operationId pauseTenant, Tenants).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | Yes | The tenant id or your own `external_id`. | |
| reason | No | Stored as `paused_reason`. Defaults to a generic reason. |