Emails
Get Email
This endpoint retrieves data of a specific Email based on JSON input. The API returns a single Email available to the user, according to the unique ID provided. If the specified Email does not exist, the response will be a "bad request".
You will only receive the Email after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Email |
RESPONSE
This endpoint returns information about all Emails available in the database.
List of the supported Emails attributes:
| Attribute | Type | Description |
|---|---|---|
| accountId | Object, Null | Account to which the Email is linked to |
| attachments | Object (Array), Null | Attachment's lists |
| body | String | Email's content |
| contactId | Object, Null | Contact to which the Email is linked to |
| date | Object | JSONObject with the time, timestamp and timeZone attributes |
| dateCreated | String | Date and time when the Email was created |
| dateDeleted | String | Date and time when the Email was deleted |
| dateUpdated | String | Date and time when the Email was last updated |
| deleted | Boolean | If true, the Email has been deleted and archived |
| emailFrom | String | Email of the person who's sending the email |
| emailTo | Array | List of Emails, that will receive the mail |
| extId | String | External ID of the Email from a third party system (ERP, CRM, Accounting System) |
| id | Integer | Unique identifier for the Email in ForceManager |
| mailFolder | String | Folder to which the mail belongs. (For example: Inbox) |
| opportunityId | Object, Null | Opportunity to which the Email is linked to |
| salesRepId | Object, Null | Id of the User responsible for the Email |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Email |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Email |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Email |
| subject | String | Email's subject |
| type | Integer | 0 -> outgoing email and 1 -> incoming email |
List of the supported Attachments attributes:
| Attribute | Type | Description |
|---|---|---|
| id | Integer | Unique identifier for the Attachment in ForceManager |
| name | String | Attachment name (include the file type (.pdf, xls...)) |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/emails/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/emails/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.