Perform OAuth
POST
/mailboxes/oauth
mailboxId or email.Google OAuth
{
"mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
"google": {
"googleOauthRoute": "https://yourapp.com/oauth/google/callback",
"clientId": "your-google-client-id",
"appName": "YourApp"
}
}Microsoft OAuth
{
"mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
"microsoftOauthRoute": "https://yourapp.com/oauth/microsoft/callback"
}Note: This endpoint is rate-limited to 10 requests per mailbox per week. The OAuth flow must be completed by the end user in a browser.
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/oauth' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
"email": "alice@acmecorp.com",
"google": {
"googleOauthRoute": "https://yourapp.com/oauth/google/callback",
"clientId": "your-google-client-id",
"appName": "YourApp"
},
"microsoftOauthRoute": "https://yourapp.com/oauth/microsoft/callback"
}'Response Response Example
200 - Example 1
{
"status": 200,
"message": "OAuth wil be performed performed shortly",
"data": null,
"actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}Modified at 2026-08-06 06:20:56