Save custom email server
Send your clients' emails through your own email server, so they come from your domain. The server is checked with a live login before anything is saved. If the login fails, nothing changes and the response is 400 with the reason. Save your brand first.
Reseller accounts only. Request access.
Email server host name.
Email server port, usually 587 for starttls or 465 for ssl.
Login name.
Login password. Leave it blank to use the saved password.
curl -X POST 'https://backend.omnidim.io/api/v1/reseller/identity/smtp/save' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "host": "smtp.acme.example", "port": 587, "username": "mailer@acme.example", "password": "app-password", "encryption": "starttls", "from_email": "hello@acme.example" }'
{ "success": true, "can_use_brand_identity": true, "can_use_custom_smtp": true, "has_identity": true, "identity": { "platform_name": "Acme Voice", "company_name": "Acme Ltd", "real_email": "hello@acme.example" }, "smtp": { "configured": true, "active": true, "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.
application/jsonhost*stringEmail server host name.
port*integerEmail server port, usually 587 for starttls or 465 for ssl.
username?stringLogin name.
password?stringLogin password. Leave it blank to use the saved password.
encryption?string"starttls""starttls""ssl""none"from_email?stringAddress your clients' emails are sent from.
Response body
application/jsonThe server was saved and is in use. 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?Save brand identity
Set the brand your client organizations see: your brand name and company name on their emails, and your brand name spoken in their verification calls. The first save creates the brand. Later saves change only the fields you send. Your own emails do not change.
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.
