Enable Messaging

POST /tenants/{tenant}/practice/messaging

Switches messaging on for the practice: its messaging account is found or created through Account Hub and set up in the Messaging Service. Safe to repeat, and repeating finishes a switch-on that failed part-way (status SettingUp). 409 while messaging is switched off in this environment, or Sodium has not allowed the practice to use it (messaging_not_allowed); 503 when the Messaging Service is unavailable, after which the practice stays SettingUp.

Requires: Admin on Messaging.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

Responses

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