CRM · Inbox & Calendar
Mailbox Connections
Your Microsoft 365 or Google mailbox and calendar, logged into CRM as emails and meetings against the people and companies they involve. Nothing is read until you opt in; you choose what is kept.
/api/crm/mailbox-connectionsDownload specification (OpenAPI 3.1) Screen: Mailbox Connections
Overview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Mailbox Connections on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/mailbox-connectionsRead mailbox connections
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/mailbox-connections" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/mailbox-connections/{id}Read mailbox connections
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/mailbox-connectionsPost mailbox connections
Request body
The keys this action reads (* = required; "one of" lists the only values):
provider; provider one of microsoft365|google|sandboxResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"provider;":"value"}'PUT/api/crm/mailbox-connections/{id}Put mailbox connections
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
store_body, opted_in, sync_mail, sync_calendar, push_meetings, exclude_domains, exclude_labels, skip_private, log_unmatched; store_body one of none|snippet|fullResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"store_body":"value","opted_in":"value","sync_mail":"value","sync_calendar":"value","push_meetings":"value","exclude_domains":"value"}'POST/api/crm/mailbox-connections/{id}/authorizeAuthorize
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/authorize" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/mailbox-connections/{id}/syncSync
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sync" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/mailbox-connections/{id}/uploadUpload
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
fileName, content*, encodingResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/upload" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fileName":"value","content":"value","encoding":"value"}'POST/api/crm/mailbox-connections/{id}/pausePause
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pause" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/mailbox-connections/{id}/resumeResume
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resume" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/mailbox-connections/{id}/revokeRevoke
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/mailbox-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revoke" \
-H "Authorization: Bearer $TOKEN"Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Mailbox Connections for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.