Save Mailbox Domain
Define your own mail domain for your partner account. Once set, new mailboxes created for the companies linked to your partner account are created under your domain instead of the platform's default domain; sending the request again updates the existing domain.
Endpoint
| Property | Value |
|---|---|
| URL | PUT /white-label-partner/mail-domain |
| Method | PUT |
| Auth | R-Auth: <partner-jwt> |
| Content-Type | application/json |
| Base URL | Stage Environment https://api-stage.docnova.ai/ Production Environment https://api.docnova.ai/ |
Example Request
curl --location --request PUT '{{baseUrl}}/white-label-partner/mail-domain' \
--header 'Content-Type: application/json' \
--header 'R-Auth: {{partnerJwt}}' \
--data-raw '{
"domain": "mail.example.com"
}'
Request body
{
"domain": "mail.example.com"
}
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Domain used for new mailboxes (e.g. mail.example.com). Max 255 characters, must not be blank. |
note
The domain is trimmed and stored in lowercase. A domain can belong to only one partner at a time; a domain already used by another partner cannot be saved.
note
Changing the domain affects only mailboxes created afterwards; existing mailbox addresses do not change.
Response
"mail.example.com"
Response fields
| Field | Type | Description |
|---|---|---|
(body) | string | The saved domain (lowercased). The response is a plain text value, not a JSON object. |
Response Codes
| Code | Description |
|---|---|
200 | OK — Mail domain saved. Example value: mail.example.com |
201 | Created |
400 | Bad Request — domain is blank or longer than 255 characters |
401 | Unauthorized — R-Auth header missing or invalid, or the account is not an active partner |
403 | Forbidden — Partner is not authorized for this operation |
404 | Not Found |
409 | Conflict — Domain is already used by another partner (PARTNER_MAIL_DOMAIN_ALREADY_CLAIMED) |