Custom domains

Custom domains allow organizations to send transactional emails (invoices, proposals, notifications) from their own domain rather than a Productive-managed address.

Configure and verify DNS records (SPF, DKIM, MX) for your domain through these endpoints. A verified custom domain improves email deliverability and reinforces brand identity.

Attributes

allow_user_email boolean
Response Request

Whether to allow user email.
email_sender_address string
Response Request

The email address used as the sender when sending emails via this custom domain.
email_sender_name string
Response Request

The sender name for emails.
id integer
Parameter `filter`

The unique identifier of this custom domain.
mailgun_dkim string
Response

The DKIM DNS record required for email authentication via Mailgun for this custom domain.
mailgun_mx object
Response

The MX DNS records required for Mailgun email routing for this custom domain.
mailgun_spf string
Response

The SPF DNS record required for email sender authentication via Mailgun for this custom domain.
name string
Response Request Parameter `filter`

The custom domain name (hostname) used for client-facing portals.
organization organization
Response

The organization this custom domain belongs to.
subsidiaries array of subsidiary
Response

The subsidiaries that use this custom domain.
verified_at string
Response

Timestamp when this custom domain was verified, or null if verification is still pending.

Operations

GET /api/v2/custom_domains
Get custom domains
POST /api/v2/custom_domains
Create a custom domain
DELETE /api/v2/custom_domains/{id}
Deletes a custom domain
GET /api/v2/custom_domains/{id}
Gets a custom domain