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.
Reseller accounts only. Request access.
Brand name. Your clients' emails show it and their verification calls speak it. Plain text.
Company name. Plain text.
curl -X POST 'https://backend.omnidim.io/api/v1/reseller/identity/save' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "platform_name": "Acme Voice", "company_name": "Acme Ltd", "primary_color": "#1976d2", "real_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", "logo_url": "", "primary_color": "#1976d2", "real_email": "hello@acme.example" }, "smtp": { "configured": false, "active": false } }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
application/jsonplatform_name?stringBrand name. Your clients' emails show it and their verification calls speak it. Plain text.
1 <= length <= 60company_name?stringCompany name. Plain text.
1 <= length <= 60logo_url?stringPublic URL of your logo.
primary_color?stringBrand colour as a hex value, for example #1976d2.
real_email?stringSender and reply-to address on your clients' emails.
emailResponse body
application/jsonThe brand was saved. 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?Get brand identity
Read your brand and your custom email server settings. The brand is what your client organizations see: your brand name on their emails, and spoken in their verification calls. Your own emails do not change.
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.
