Export mailboxes
POST
/v2/exports/mailboxes
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 mailbox fields matching specific text. |
status (Optional) | string | Specify the status of mailboxes to export. |
thirdPartyAccountId (Optional) | string | Pin export to a specific third-party account. Required when multiple accounts of the same app exist in the workspace. |
orgId (Optional) | string | Target organization on the third-party app. Required for apps with organizations: INSTANTLY, REPLY_IO, QUICKMAIL, PIPL, SUPERAGI, MASTER_INBOX, SAILE, HOTHAWK, ALIEN_MAIL. Get it from GET /v2/exports/fetch-workspaces?app=.... |
orgName (Optional) | string | Organization name, sent alongside orgId. |
workspace (Optional) | string | Target workspace name. Required for EMAILBISON. |
Example Request
{
"apps": ["MANUAL"],
"ids": ["a4333491-23dd-3d2q-8523-8eccfc2e82a6b", "4333491-23dd-3d2q-4333491-23dd"],
"excludeIds": ["4333491-23dd-3d2q-8523-8eccfc2e82a6b"],
"tagIds": ["tag1", "tag2"],
"contains": "example",
"status": "active",
"thirdPartyAccountId": "3f9c2a7e-6d14-4b8a-9f2e-1c7d5e8b4a91"
}Example Request — export to an app with an organization
{
"apps": ["REACHINBOX"],
"ids": ["a4333491-23dd-3d2q-8523-8eccfc2e82a6b"],
"excludeIds": [],
"tagIds": [],
"contains": "",
"status": "active",
"thirdPartyAccountId": "3f9c2a7e-6d14-4b8a-9f2e-1c7d5e8b4a91",
"orgId": "org_9f8e7d",
"orgName": "Acme Outreach"
}Example Request — export to EmailBison
{
"apps": ["EMAILBISON"],
"ids": [],
"excludeIds": [],
"tagIds": ["tag1"],
"contains": "",
"status": "active",
"workspace": "Acme Outreach"
}Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/v2/exports/mailboxes' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;' \
--header 'Content-Type: application/json' \
--data '{
"apps": [
"REACHINBOX"
],
"ids": [
"a66ccca7-d465-464a-887b-90bce6d09bbb"
],
"excludeIds": [],
"tagIds": [],
"status": "",
"contains": "",
"thirdPartyAccountId": "3f9c2a7e-6d14-4b8a-9f2e-1c7d5e8b4a91"
}'Response Response Example
200 - Success
{
"status": 200,
"message": "Mailboxes export is started. It may take sometime to export",
"data": null
}Modified at 2026-10-03 08:04:59