Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
Email

Enable catch-all receiving

Enables catch-all inbound receiving for a domain by creating a receipt rule, and returns the rule name.

POST
/v1/email/catch-all/enable

Enables catch-all inbound receiving for a domain by creating a receipt rule, and returns the rule name. endpointId is one of the organization's webhook endpoints; every address on the domain delivers message.received to it. Responds with 201.

Authorization

apiKey
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domainId*EmailDomainId
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$
endpointId*WebhookEndpointId
Match^wep_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/email/catch-all/enable" \  -H "Content-Type: application/json" \  -d '{    "domainId": "string",    "endpointId": "string"  }'
{  "success": true,  "receiptRuleName": "string"}

Disable a custom tracking domain

Disables a domain's custom tracking, removes its managed resources, and immediately returns sends to the shared tracking host.

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.