Brand and email
Put your name, logo, and sender address on the email your clients receive, from the API.
A reseller's clients can see your name on the email they receive and hear it on the verification call, instead of ours. You set one brand for your whole account and it applies to every client under it.
This is not a white-label platform: there is no domain and no branded site, only the messages your clients get. For the full platform, see OmniRelay.
Read the current state
GET /api/v1/reseller/identityReturns whether brand and custom SMTP are available, whether a brand is set, the brand itself, and the SMTP state. The SMTP password is never returned.
Set your brand
POST /api/v1/reseller/identity/save
{
"company_name": "Acme AI",
"platform_name": "Acme Voice",
"logo_url": "https://cdn.example.com/logo.png",
"primary_color": "#1976d2",
"real_email": "support@acme.example"
}| Field | Meaning |
|---|---|
platform_name | The brand name. Clients' emails show it, and the verification call speaks it, 1 to 60 characters |
company_name | The legal or company name |
logo_url | A publicly reachable logo URL |
primary_color | A hex color, such as #1976d2 |
real_email | The sender and reply-to address on your clients' email |
The first save creates the brand. Later saves update it. The response returns the whole state.
Send through your own SMTP
With a brand saved, you can send your clients' email through your own mail server.
POST /api/v1/reseller/identity/smtp/save
{
"host": "smtp.example.com",
"port": 587,
"username": "apikey",
"password": "...",
"encryption": "starttls",
"from_email": "support@acme.example"
}encryption is starttls (default), ssl, or none. The server is checked with a live
login before it is saved. A failure returns 400 with the reason. Test the login without
saving with /reseller/identity/smtp/test, which takes the same body. A blank password
means the saved one.
To send through our mail server again, call /reseller/identity/smtp/disable.
What your clients see
- With your SMTP: the email comes from your support address, and your receivers judge your domain.
- Without it: the sender is your brand name at our notifications address, and the reply-to is your support address. We never put your domain in the sender, because no server except yours may send as it.
Your own email is not changed by any of this. Only your clients' messages carry your brand.
