Add Platform Credential

POST

/exports/platform-credential

Stores a platform credential for exporting mailboxes to an external tool.

{
  "app": "EMAILBISON",
  "credentials": {
    "email": "admin@emailbison.com",
    "password": "securepassword"
  },
  "orgId": "org_xyz",
  "metadata": {
    "appBaseUrl": "https://app.emailbison.com",
    "clientId": "client_abc",
    "appName": "EmailBison",
    "workspace": "workspace_name"
  }
}

orgId is optional. metadata fields vary by app.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Platform credentials added successfully

Bodyapplication/json

🟠401Unauthorized

🟠422Unprocessable Entity

🟠400Bad Request

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/exports/platform-credential?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app": "EMAILBISON",
    "credentials": {
        "email": "admin@emailbison.com",
        "password": "securepassword"
    },
    "orgId": "org_xyz",
    "metadata": {
        "appBaseUrl": "string",
        "clientId": "string",
        "appName": "string",
        "workspace": "string"
    }
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Platform credentials added successfully",
    "data": {
        "credentialId": "cred_V2M9KP3XAQZL"
    },
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-06 06:20:56

Get Platform Credentials

Export Mailboxes to Platform