Replaces the practice's automatic top-up and low-credit alert (null switches either off) and returns the credits. Every number is positive and the monthly cap at least one top-up's blocks, else 400. Switching automatic top-up on from off needs a Direct Debit (409 billing_mandate_required) and Sodium's permission (409 messaging_not_allowed); changing it, switching it off or the alert alone does not.
Requires: Admin on Messaging.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
Request Body*
{
"autoTopUp": {
"below": 1,
"blocks": 1,
"monthlyCapBlocks": 1
},
"lowCreditAlertBelow": 1
}Responses
200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
409 Conflict
503 Service Unavailable