Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Email

Get receiving setup status

Get receiving setup status. View request and response details for this Samva email API endpoint.

GET
/v1/email/domains/{id}/receiving-status

Reports each prerequisite for receiving a domain's mail at Samva, in order: sending verified, a destination (a webhook endpoint or an active forwarding rule), receiving enabled, and the inbound MX record. The MX answer is a live DNS lookup that names the current target when mail is routed elsewhere.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

id*string
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/email/domains/string/receiving-status"
{  "domain": "string",  "receivingHost": "string",  "sending": {    "satisfied": true,    "phase": "dns-setup"  },  "destination": {    "satisfied": true,    "endpointId": "string",    "forwardingRules": 0,    "mailboxes": 0  },  "receiving": {    "satisfied": true,    "catchAll": true  },  "mx": {    "satisfied": true,    "state": "pointing-here",    "expected": {      "exchange": "string",      "priority": 0    },    "current": [      {        "exchange": "string",        "priority": 0      }    ]  },  "ready": true}

Related documentation

Get email onboarding review status

Returns the customer-safe organization review decision, workflow stage, next action, and current sending-identity clearances.

Get a recipient tracking preference

Returns the organization-scoped tracking opt-out for a normalized recipient email. A missing preference reads as opted in and is not created.