Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Email

Enable catch-all receiving

Enables catch-all inbound receiving for a verified domain.

POST
/v1/email/domains/{id}/enable-catch-all

Enables catch-all inbound receiving for a verified domain. endpointId is one of the organization's webhook endpoints; every address on the domain delivers message.received to it. Omit it to deliver through forwarding rules alone, which needs at least one active forwarding rule covering the domain. Mail that matches neither a rule nor an endpoint is rejected as an unknown recipient. Responds with 201.

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.

endpointId?|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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

Related documentation

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.