Emails
Create Email
This endpoint allows you to create an Email based on JSON input.
You will only be able to create an 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 BODY
| Attribute | Type | Description |
|---|---|---|
| accountId | Integer | 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 | String | Date and time when the Email was sent or received |
| 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) |
| mailFolder | String | Folder to which the mail belongs. (For example: Inbox) |
| opportunityId | Integer | Opportunity to which the Email is linked to |
| salesRepId | Integer | First sales representative responsible for 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 |
|---|---|---|
| name | String | Attachment name (include the file type (.pdf, xls...)) |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| id | Integer | Id assigned to the new WebHook |
| Message | String | Shows the operation status |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows the emails that will receive the email and the operation's id |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
post/emails
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/emails
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Email
Changes
No recorded changes to this operation across all 1 revision of this API.