Disable custom email server
Stop sending your clients' emails through your own email server. Their emails go back to the default sender. The saved server and its login are kept, so you can switch it on again with POST /reseller/identity/smtp/save. Your brand is not changed.
Reseller accounts only. Request access.
curl -X POST 'https://backend.omnidim.io/api/v1/reseller/identity/smtp/disable' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "success": true, "can_use_brand_identity": true, "can_use_custom_smtp": true, "has_identity": true, "identity": { "platform_name": "Acme Voice", "company_name": "Acme Ltd" }, "smtp": { "configured": true, "active": false, "host": "smtp.acme.example", "port": 587, "username": "mailer@acme.example", "encryption": "starttls", "from_email": "hello@acme.example" } }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
Response body
application/jsonCustom email server turned off. The body is the full brand state.
application/jsonYour brand and custom email server state. The SMTP password is never returned.
success?booleancan_use_brand_identity?booleanWhether this account may hold a brand. When false, every write returns 403.
can_use_custom_smtp?booleanWhether this account may send clients' emails through its own email server.
has_identity?booleanfalse until the first save.
identity?The saved brand. Empty until the first save. Other branding keys can appear.
smtp?Test custom email server
Check that a login to an email server works. Nothing is saved and nothing changes for your clients. Use it before POST /reseller/identity/smtp/save.
Get usage across your clients
Your whole book for one period: each client's minutes, calls, spend and the margin you made on it, your totals, how long your balance will last, and your recurring revenue.
