Export mailboxes

POST

/v2/exports/mailboxes

Export Mailboxes

This endpoint allows you to export mailboxes to a third-party application or as a CSV file.

Endpoint

Request Body

Name	Type	Description
`apps`	`array`	Name of third-party apps where mailboxes should be exported. To export as a CSV file, use `["MANUAL"]`.
`ids` (Optional)	`array`	IDs of mailboxes to export.
`excludeIds` (Optional)	`array`	IDs of mailboxes that should not be exported.
`tagIds` (Optional)	`array`	Tag IDs of domains.
`contains` (Optional)	`string`	Search filter for mailboxes matching specific criteria.
`status` (Optional)	`string`	Specify the status of mailboxes to export.

Example Request

{
    "apps": ["MANUAL"],
    "ids": ["12345", "67890"],
    "excludeIds": ["54321"],
    "tagIds": ["tag1", "tag2"],
    "contains": "example",
    "status": "active"
}

Request

Header Params

x-auth-zapmail

string

required

Example:

Body Params application/json

object {0}

Example

{
    "apps": [
        "REACHINBOX"
    ],
    "ids": [
        "a66ccca7-d465-464a-887b-90bce6d09bbb"
    ],
    "excludeIds": [],
    "tagIds": [],
    "status": "",
    "contains": ""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zapmail.ai/api/v2/exports/mailboxes' \
--header 'x-auth-zapmail: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apps": [
        "REACHINBOX"
    ],
    "ids": [
        "a66ccca7-d465-464a-887b-90bce6d09bbb"
    ],
    "excludeIds": [],
    "tagIds": [],
    "status": "",
    "contains": ""
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "status": 200,
    "message": "Mailboxes export is started. It may take sometime to export",
    "data": null
}

Modified at 2025-01-30 13:10:39

Enable auto recharge

Add third party account details

Export mailboxes

Export Mailboxes#

Endpoint#

Request Body#