Domains

Update domain allowlist

Replace the allowlist for a domain. The allowlist restricts inbound mail to only the specified senders. Each entry must be a valid IP address, fully qualified domain name (FQDN), email address, or wildcard top-level domain (e.g. *.com). A maximum of 1000 entries is allowed. Wildcard public-suffix rules may contain multiple labels, for example *.gov.co and *.gov.br; they match senders under that exact suffix.

put/v1/domains/{domain_id}/allowlist

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains/{domain_id}/allowlist
  • Auth: HTTP basic

Path parameters

domain_idstring required

Fully qualified domain name (FQDN) or domain ID

Request body

allowliststring[] required

Array of allowlisted senders (IP addresses, FQDNs, email addresses, or wildcard TLDs such as *.com). Pass an empty array to clear the allowlist. Wildcard public-suffix rules may contain multiple labels, for example *.gov.co and *.gov.br; they match senders under that exact suffix.

Response

Domain updated successfully

domain_updatesobject[]
has_pending_domain_updatesboolean
has_newsletterboolean
ignore_mx_checkboolean
allow_subdomain_forwardingboolean

Allow wildcard subdomain forwarding. When enabled on a paid plan (Enhanced Protection or Team), any subdomain that has no DNS records of its own inherits the forwarding configuration published at this domain’s root (apex). Verified ownership is required: the apex must publish a forward-email-site-verification record matching this domain. This setting does not apply to the free plan.

has_delivery_logsboolean
retention_daysinteger
has_regexboolean
has_catchallboolean
allowliststring[]
denyliststring[]
restricted_alias_namesstring[]
has_adult_content_protectionboolean
has_phishing_protectionboolean
has_executable_protectionboolean
has_virus_protectionboolean
is_catchall_regex_disabledboolean
has_smtpboolean
is_smtp_suspendedboolean
planstring
max_recipients_per_aliasinteger
alias_default_smtp_limitinteger

Default daily SMTP sending limit applied to newly created aliases on this domain. Set to 0 to disable (aliases will use the domain-wide limit). Cannot exceed the domain's effective SMTP limit.

smtp_portstring
membersobject[]
invitesobject[]
namestring
has_mx_recordboolean
has_txt_recordboolean
has_dkim_recordboolean
has_return_path_recordboolean
has_dmarc_recordboolean
has_strict_dmarcboolean
has_spf_recordboolean
has_autoconfig_recordboolean
has_autodiscover_recordboolean
has_recipient_verificationboolean
has_custom_verificationboolean
has_custom_s3boolean

Whether this domain uses custom S3-compatible storage for backups

s3_endpointstring

Custom S3-compatible endpoint URL (e.g. https://s3.us-east-1.amazonaws.com, https://<accountid>.r2.cloudflarestorage.com)

s3_regionstring

S3 region (e.g. us-east-1, auto). Defaults to auto if not specified.

s3_bucketstring

S3 bucket name for storing backups. The bucket must already exist.

require_tls_inboundboolean

When enabled, reject inbound emails not sent over TLS

verification_recordstring
idstring
object'domain'
created_atstring date-time
updated_atstring date-time
storage_usedinteger
storage_used_by_aliasesinteger
storage_quotainteger
zone_filestring

Every DNS record the domain needs (MX, verification, SPF, DKIM, Return-Path, DMARC, and autodiscovery) as a zone file to import into a DNS provider. Only included when a domain is retrieved or created, for domain admins.

linkstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.