INinstantly
DomainForwarding

Set domain forwarding

Changed on

Sets web forwarding on a domain ordered through Instantly. The forwarding domain must be a valid domain different from the domain itself. Returns a conflict error while the domain order is still being provisioned, and an unprocessable entity error when the requested forwarding configuration is not supported for the domain. This request has a rate limit of 10 requests per minute, or 60 requests per hour.

Requires one of the following scopes: dfy_email_account_orders:update, dfy_email_account_orders:all, all:update, all:all

put/api/v2/domains/{domain}/forwarding

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/domains/{domain}/forwarding
  • Auth
    HTTP bearer

Path parameters

domainstring required
Example:example.com

The domain to manage forwarding for

Request body

forwarding_domainstring required

Destination domain visitors are forwarded to

forwarding_mode'redirect' | 'stealth'

How the forwarding domain is applied. Defaults to redirect.

Example request

{
  "forwarding_domain": "mycompany.com",
  "forwarding_mode": "redirect"
}

Response

The requested Domain Forwarding

domainstring required

The domain the forwarding configuration applies to

forwarding_domainstring nullable

Destination domain visitors are forwarded to. Null when no forwarding is configured.

forwarding_mode'redirect' | 'stealth' | 'null' nullable

How the forwarding domain is applied. Null when no forwarding is configured.

Example response

{
  "domain": "example.com",
  "forwarding_domain": "mycompany.com",
  "forwarding_mode": "redirect"
}

Changes