Get Mailbox Domain
Get the mail domain configured for your partner account. It is used instead of the platform's default domain when creating new mailboxes for the companies linked to your partner account.
Endpoint
| Property | Value |
|---|---|
| URL | GET /white-label-partner/mail-domain |
| Method | GET |
| Auth | R-Auth: <partner-jwt> |
| Base URL | Stage Environment https://api-stage.docnova.ai/ Production Environment https://api.docnova.ai/ |
Example Request
curl --location '{{baseUrl}}/white-label-partner/mail-domain' \
--header 'accept: */*' \
--header 'R-Auth: {{partnerJwt}}'
Request fields
This endpoint takes no parameters or request body.
Response
"mail.example.com"
Response fields
| Field | Type | Description |
|---|---|---|
(body) | string | The partner's configured mail domain. The response is a plain text value, not a JSON object. If no domain is configured, the response body is empty and new mailboxes use the platform's default domain. |
Response Codes
| Code | Description |
|---|---|
200 | OK — Returns the partner's mail domain (empty body if none is configured) |
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 |