Every endpoint in Email: 27 operations across 13 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Messages
GET/api/email/messages
List messages
curl -X GET https://app.jaicrm.ai/api/email/messages
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/email/messages/{id}
Read one message
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/email/messages/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/email/messages/{id}/thread
List thread
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/email/messages/RECORD_ID/thread
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/messages/{id}/forward
Create a forward
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/email/messages/RECORD_ID/forward
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/messages/{id}/important
Create an important
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/email/messages/RECORD_ID/important
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/messages/{id}/read
Create a read
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/email/messages/RECORD_ID/read
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/messages/{id}/reply
Create a reply
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/email/messages/RECORD_ID/reply
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/messages/bulk
Create a bulk
curl -X POST https://app.jaicrm.ai/api/email/messages/bulk
-H 'Authorization: Bearer YOUR_API_KEY'Drafts
GET/api/email/drafts
List drafts
curl -X GET https://app.jaicrm.ai/api/email/drafts
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/email/drafts/{id}
Read one draft
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/email/drafts/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/email/drafts
Change a draft
curl -X PUT https://app.jaicrm.ai/api/email/drafts
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/email/drafts/{id}
Delete a draft
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/email/drafts/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Bulk
GET/api/email/bulk/{batchId}
Read one bulk
| Parameter | Type | Required | Notes |
|---|---|---|---|
batchId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/email/bulk/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/bulk
Create a bulk
curl -X POST https://app.jaicrm.ai/api/email/bulk
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/bulk/{batchId}/cancel
Create a cancel
| Parameter | Type | Required | Notes |
|---|---|---|---|
batchId | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/email/bulk/RECORD_ID/cancel
-H 'Authorization: Bearer YOUR_API_KEY'Sense
GET/api/email/sense
List sense
curl -X GET https://app.jaicrm.ai/api/email/sense
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/email/sense/seen
Create a seen
curl -X POST https://app.jaicrm.ai/api/email/sense/seen
-H 'Authorization: Bearer YOUR_API_KEY'U
GET/api/t/u/{token}
Read one u
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/t/u/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/t/u/{token}
Act on an u
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/t/u/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Counts
GET/api/email/counts
List counts
curl -X GET https://app.jaicrm.ai/api/email/counts
-H 'Authorization: Bearer YOUR_API_KEY'Recipients
GET/api/email/recipients
List recipients
curl -X GET https://app.jaicrm.ai/api/email/recipients
-H 'Authorization: Bearer YOUR_API_KEY'Attachments
POST/api/email/attachments
Create an attachment
curl -X POST https://app.jaicrm.ai/api/email/attachments
-H 'Authorization: Bearer YOUR_API_KEY'Compose
POST/api/email/compose
Create a compose
curl -X POST https://app.jaicrm.ai/api/email/compose
-H 'Authorization: Bearer YOUR_API_KEY'Senders
GET/api/email/senders
List senders
curl -X GET https://app.jaicrm.ai/api/email/senders
-H 'Authorization: Bearer YOUR_API_KEY'Images
POST/api/email/images
Create an image
curl -X POST https://app.jaicrm.ai/api/email/images
-H 'Authorization: Bearer YOUR_API_KEY'O
GET/api/t/o/{token}.gif
Read one o
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/t/o/RECORD_ID.gif
-H 'Authorization: Bearer YOUR_API_KEY'C
GET/api/t/c/{token}/{index}
Read one c
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
index | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/t/c/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.