Enable catch all emails

POST

/v2/domains/catch-all

Activate Catch-All Email Forwarding for Domain

This endpoint lets you activate catch-all email functionality for your domain, so all emails sent to any address at the domain are forwarded to a specified email address.

Endpoint

Request Body

Name	Type	Description
`domainIds`	`array`	An array of domain IDs for which catch-all email forwarding should be enabled.
`email`	`string`	The email address where all messages sent to any address at the domain should be forwarded.
`contains`	`string`	(Optional) Enable catch-all email forwarding only for domains that match the specified keyword.

Example Request

{
    "domainIds": ["domainId1", "domainId2"],
    "email": "forward@example.com",
    "contains": "example"
}

Request

Header Params

x-auth-zapmail

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

object {0}

Example

{
  "status": 200,
  "message": "Catch all email will update soon",
  "data": null
}

Remove email forwarding

Remove catch all emails

Enable catch all emails

Activate Catch-All Email Forwarding for Domain#

Endpoint#

Request Body#