Buys blocks of messaging credits at the practice's block price, added to the balance at once and to the next invoice. Credits never expire and are not refunded. Make requestId once per purchase: sending it again returns the first purchase and buys nothing. 400 for a block count outside 1 to the most one purchase may buy; 409 billing_mandate_required without a Direct Debit, messaging_not_allowed when Sodium has not allowed messaging, or while the practice's messaging is not set up; 503 when Account Hub or the Messaging Service is unavailable.
Requires: Admin on Messaging.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
Request Body*
{
"blocks": 1,
"requestId": "00000000-0000-0000-0000-000000000000"
}Responses
201 Created
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