Re-export a mailbox (Oauth)

POST

/mailboxes/oauth

This endpoint triggers a re-export of an existing mailbox using OAuth-based authentication.

The request supports OAuth configurations for providers such as Microsoft and Google and requires the target mailbox ID along with the associated email address.

Rate Limit:

Re-export requests are limited to 3 times per mailbox per week. If this limit is exceeded, requests will be rejected, regardless of whether they are initiated via the API or the dashboard.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Header Params

Body Params application/json

Example

{
   "microsoftOauthRoute": "",
    "google": {
        "googleOauthRoute": "https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?access_type=offline...",
        "clientId": "549360251880-maeh4okn7btu9cjtf0l2bt1t5b22sbf8.apps.googleusercontent.com",
        "appName": "Outreach App"
    },
    "mailboxId": "39XXMZ1SQMMWWPN2GCRB0Q78KZAR", // OR use mailbox email
    "email": "john@doe.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/oauth' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "microsoftOauthRoute": "",
    "google": {
        "googleOauthRoute": "https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?access_type=offline...",
        "clientId": "549360251880-maeh4okn7btu9cjtf0l2bt1t5b22sbf8.apps.googleusercontent.com",
        "appName": "Outreach App"
    },
    "mailboxId": "39XXMZ1SQMMWWPN2GCRB0Q78KZAR", // OR use mailbox email
    "email": "john@doe.com"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "OAuth wil be performed performed shortly",
    "data": null
}

Modified at 2026-01-27 22:30:18

Prewarmup Events

Get all pre warmed up mailboxes