The Platform Exports API lets you securely store platform credentials and export mailboxes to connected applications.
| Platform | Identifier |
|---|
| EmailBison | EMAILBISON |
Endpoints#
| Method | Endpoint | Purpose |
|---|
POST | /exports/platform-credential | Store & validate credentials |
POST | /exports/platform-exports | Queue mailboxes for export |
GET | /exports/platform-credentials | List stored credentials per platform |
DELETE | /exports/platform-credential | Remove credentials |
Flow#
1. POST /platform-credential
└─ Validates credentials live → stores them → returns credentialId
2. GET /platform-credentials
└─ Returns all stored credentials and their credentialIds
3. POST /platform-exports (credentialId + componentMailboxIds)
└─ Queues mailboxes for export
4. DELETE /platform-credential (credentialId)
└─ Removes the stored credential
Key Behaviors#
✅ Credentials validated live — Invalid credentials return 400 before storage✅ Multiple credentials supported — Each call to /platform-credential creates a new entry with a unique credentialId✅ Async export — 200 status means the job is queued, not completed.✅ Ownership enforced — Credentials and mailboxes must belong to the requesting user on every operation
Error Codes Reference#
| Code | Scenario |
|---|
400 | Invalid request format or failed credential validation |
401 | Missing or invalid API key / userId |
403 | Credentials or mailboxes don't belong to this user |
404 | Credential or mailbox not found |
500 | Platform connection error (retry safe) |
Tips#
💡 Store once, reuse many — Save the credentialId from Step 1 and use it for all future exports💡 Batch mailboxes — Export multiple mailboxes in a single call rather than one-by-one💡 No re-auth needed — After Step 1, never re-send credentials. Use the credentialId💡 Check connectivity — Use GET /platform-credentials to verify which platforms are connected
Avoid These Common Issues#
Re-sending credentials on every export: Store the credentialId returned by POST /platform-credential and reuse it. Sending raw credentials again just creates a duplicate, unrelated entry.
Treating 200 as completed: A successful response means the export was queued, not finished. Confirm delivery on the receiving platform before assuming it's done.
Cross-user credentials or mailboxes: Credentials and mailboxes must belong to the requesting user. Mixing IDs across users returns a 403.
Skipping validation: Invalid credentials fail at POST /platform-credential before anything is stored — there's no way to save a bad credential and fix it later. Re-submit with corrected values instead.
Next Steps#
OAuth Exports
Export mailboxes via OAuth instead of stored credentials.
Mailboxes
Find the mailbox IDs you'll pass to platform-exports.
Mailbox Events
Track mailbox creation before exporting. Modified at 2026-08-05 16:12:50
