Skip to main content
PATCH
UpdateSendingDomainAPI edits a sending domain's identity settings — from

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Path Parameters

domain
string
required

Body

application/json
domain
string
forward_to_email
string
from_local_part
string
from_name
string
receiving_enabled
boolean

Response

Success response

created_at
string
dns_records
SendingDomainDNSRecord is one DNS record the customer must create at their DNS · object[]

provider. Kept after verification too, so a domain that regresses can be compared against what should exist.

domain
string

punycode) — an apex ("acme.com") or a subdomain ("hello.acme.com"). It is the identifier every other sending-domain endpoint takes.

error_reason
string

(e.g. the DKIM record was not found); empty otherwise.

existing_mx_detected
boolean

at a mailbox provider (Google Workspace, Microsoft 365) when it was registered. Adding Erdo's MX to that same name would break the customer's existing mail, so receiving must instead be set up on a subdomain ("hello.acme.com") or left off — say so rather than handing over the MX record.

forward_to_email
string

business reads its own mail in the place it already works. Empty means replies are stored in Erdo only.

from_email
string

active — from_local_part@domain.

from_local_part
string
from_name
string

means the address shows alone.

last_checked_at
string

provider (RFC 3339); empty if never checked yet.

receiving_enabled
boolean

Erdo. It requires the MX record among dns_records, which cannot coexist with an existing mailbox provider's MX on the same name — see existing_mx_detected.

registered_receiving
boolean

the provider, fixed for the registration's life. False means receiving can never be enabled on this registration — to receive, remove the domain and register it (or a subdomain) again.

status
string

customer to create the listed DNS records), "active" (verified — mail now leaves from this domain), "failed" (a record is missing or wrong; see error_reason), or "disabled" (deregistered upstream). Only "active" changes what recipients see; every other state means sends still go out as hello@mail.erdo.ai.

updated_at
string