Enable catch-all receiving

Enables catch-all inbound receiving for a verified domain without requiring a destination.

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

Enables catch-all inbound receiving for a verified domain without requiring a destination. endpointId is one of the organization's webhook endpoints; every address on the domain delivers message.received to it. Without an endpoint, forwarding rules and active mailboxes receive matching addresses. Unknown addresses reach unknownRecipientMailboxId when configured, otherwise they are dropped without a bounce. Responds with 201.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

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

Request Body

application/json
  1. body
endpointId?|null

Response Body

Success

application/json
  1. response
success*true
Value intrue
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.enableCatchAll({  "id": "example"});
Example Response
{  "success": true}

Related documentation