domains

Enable or disable catch-all for a verified custom domain

Business plan only. Enabling requires the domain to be verified (else 409 domain_not_verified). inbox_id is optional: when omitted, a catch-all inbox is created and bound to the domain (subject to the plan's inbox cap, else 403 inbox_limit_reached); when given, it must be a live inbox already bound to this domain (else 422 catch_all_target_invalid, or 404 domain_not_found_or_unverified if it does not exist / is not owned by the caller). Disabling keeps the designated inbox bound (inert while catch_all is false) so re-enabling is cheap. Rate-limited: at most 6 toggle calls per domain per hour (429 catch_all_rate_limited).

patch/domains/{id}/catch_all

Request

  • Base URL: https://dash.mailsocket.app/api/v1
  • URL: https://dash.mailsocket.app/api/v1/domains/{id}/catch_all
  • Auth: HTTP bearer

Path parameters

idstring required

The domain public ID (e.g. dom_...).

Request body

catch_allboolean required
inbox_idstring nullable

Optional; only meaningful when enabling.

Response

The domain after the catch-all toggle.

Changes

No recorded changes to this operation across all 1 revision of this API.