Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
Email

Enable inbound email for a domain

Enables inbound receiving for a verified domain by creating a receipt rule, and returns the rule name and its recipient addresses.

POST
/v1/email/domains/{id}/receiving

Enables inbound receiving for a verified domain by creating a receipt rule, and returns the rule name and its recipient addresses. Set catchAll to route every address on the domain; that requires a webhook endpoint, supplied as endpointId or already configured on the domain.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domain*string
catchAll?boolean|null
endpointId?|null
addresses?array<string>|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/email/domains/string/receiving" \  -H "Content-Type: application/json" \  -d '{    "domain": "string"  }'
{  "success": true,  "ruleName": "string",  "recipients": [    "string"  ]}

Related

Enable a custom tracking domain

Provisions a custom tracking domain (default label `track`) for a verified sending domain so open/click links redirect through the customer's own subdomain.

List blocked email logs

Returns a log of inbound emails that were blocked, optionally filtered by block entry, sender, or date range.