INinstantly
DomainForwarding

Get domain forwarding

Changed on

Returns the stored web forwarding configuration for a domain ordered through Instantly. All fields except domain are null when no forwarding is configured.

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

get/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

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