Mail Forwarding

Download schema

Endpoints for managing mail forwarding.

Show mail-forwarding status

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/status

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Returns the current provisioning status and paid renewal date for the domain.

Show mail-forwarding status › path Parameters

domainNameOrId

string · required

full domain name or ID

Show mail-forwarding status › Responses

MailForwarding

MailForwarding · required

Enable mail forwarding

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/enable

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Configures mail forwarding and starts DNS verification. The request returns while verification is pending. The domain must use hosted DNS. Existing aliases are imported when the domain already exists at the forwarding provider.

This endpoint could result in a charge to the authenticated team's payment method or an invoice being created. Re-enabling before the current renews_at date does not create another charge.

This endpoint may remove conflicting DNS records so mail forwarding can work.

Enable mail forwarding › path Parameters

domainNameOrId

string · required

full domain name or ID

Enable mail forwarding › Responses

Mail forwarding was configured and DNS verification is pending.

MailForwarding · required

Retry mail-forwarding verification

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/verification/retry

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Repairs missing provider or DNS configuration and restarts verification after a failed attempt.

Retry mail-forwarding verification › path Parameters

domainNameOrId

string · required

full domain name or ID

Retry mail-forwarding verification › Responses

Mail-forwarding verification was restarted.

MailForwarding · required

Disable mail forwarding

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/disable

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Removes the forwarding zone, all aliases, and mail DNS records that can be safely identified as managed (modified or ambiguous DNS records remain unchanged). Any unused time in the current paid period remains available until renews_at, so you can re-enable mail forwarding before that date without another charge. While disabled, mail forwarding will not renew or create another charge when the paid period ends.

Disabling mail forwarding does not refund any unused time in the current paid period.

Disable mail forwarding › path Parameters

domainNameOrId

string · required

full domain name or ID

Disable mail forwarding › Responses

MailForwarding

MailForwarding · required

List mail forwards

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Returns the aliases currently configured for the domain. Aliases can be managed while mail forwarding is pending, active, or failed.

List mail forwards › path Parameters

domainNameOrId

string · required

full domain name or ID

List mail forwards › query Parameters

sort

string[] · maxItems: 2 · style: form

Sort by alias or id. Separate multiple fields with commas and prefix a field with - for descending order.

Enum values:

alias

-alias

-id

Default: ["alias"]

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 50

List mail forwards › Responses

Paginated set of MailForward

MailForward[] · required

object · required

Create mail forward

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Adds an alias to a pending, active, or failed mail-forwarding zone. The domain must use hosted DNS.

This endpoint may remove conflicting DNS records so mail forwarding can keep working.

Create mail forward › path Parameters

domainNameOrId

string · required

full domain name or ID

Create mail forward › Request Body

MailForwardRequest

alias

string · maxLength: 255 · required

The local part to forward. Use * as a catch-all alias.

target

string · email · maxLength: 255 · required

The email address that receives forwarded messages.

Create mail forward › Responses

MailForward

MailForward · required

Show mail forward

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/{mailForwardId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Returns one alias configured for the domain. Aliases can be managed while mail forwarding is pending, active, or failed.

Show mail forward › path Parameters

domainNameOrId

string · required

full domain name or ID

mailForwardId

string · required

mail-forward ID

Show mail forward › Responses

MailForward

MailForward · required

Update mail forward

PUT

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/{mailForwardId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Replaces the alias and target of one mail forward while mail forwarding is pending, active, or failed. The domain must use hosted DNS.

This endpoint may remove conflicting DNS records so mail forwarding can keep working.

Update mail forward › path Parameters

domainNameOrId

string · required

full domain name or ID

mailForwardId

string · required

mail-forward ID

Update mail forward › Request Body

MailForwardRequest

alias

string · maxLength: 255 · required

The local part to forward. Use * as a catch-all alias.

target

string · email · maxLength: 255 · required

The email address that receives forwarded messages.

Update mail forward › Responses

MailForward

MailForward · required

Delete mail forward

DELETE

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/redirects/mail/{mailForwardId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Removes one alias from a pending, active, or failed mail-forwarding zone.

Delete mail forward › path Parameters

domainNameOrId

string · required

full domain name or ID

mailForwardId

string · required

mail-forward ID

Delete mail forward › Responses

No content

No data returned

Web Redirects Contacts