|
EmailMessage
EmailMessage represents an email message object within the system.
Supported API Calls: Get | Add | Update | Delete | SendEmailMessage
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique Id value for the email object. |
|
ParentId |
integer |
ParentID is the id of the parent record (e.g., a lead, a contact, etc.). This value is optional. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the email object is a child of. Values are lead, account (if it's an organization), contact, opportunity, project, case. |
|
FromAddress |
string (100) |
The email that would appear in the from field. |
|
FromName |
string (100) |
The name of the sender. |
|
ToAddress |
string (100) |
The email of the recipient. Comma separate multiple addresses. For example: me@me.com,him@him.com |
|
CcAddress |
string (100) |
Any CC emails. |
|
BccAddress |
string (100) |
Any Bcc emails. |
|
Subject |
string (100) |
The email's subject. |
|
HtmlBody |
string (100) |
The body of the email. |
|
IsIncoming |
boolean |
Indicates if the email coming into BlueCamroo. |
|
IsSend |
boolean |
Indicates if the email has been sent out from BlueCamroo. |
|
MessageDate |
DateTime |
The email's sent time or arrival time. This is optional. This cannot be modified. It is read only. |
|
OwnerId |
integer |
The ID of the internal user who owns the email object. |
|
AttachmentList |
List<AttachmentAssociate> |
A list of any attachment objects. |
|
RecipientList |
List<EmailMessageRecipient> |
List of recipients. |
Get
Description
Returns a message.
URL
https://{company}.bluecamroo.com/api/emailmessage/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the email object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the email message object to your list of email messages. Add does not send an email.
URL
https://{company}.bluecamroo.com/api/emailmessage/add
HTTP Method
POST
Parameters
An emailmessage object
Data Return
Returns the emailmessage object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass an email message object to replace the specified email message.
URL
https://{company}.bluecamroo.com/api/emailmessage/update
HTTP Method
PUT
Parameters
An emailmessage object
Data Return
Returns the emailmessage object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified email message.
URL
https://{company}.bluecamroo.com/api/emailmessage/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Send
Description
Sends an email message
URL
https://{company}.bluecamroo.com/api/emailmessage/emailmessage/send
HTTP Method
POST
Object Properties
An emailmessage object
Data Return
Returns the emailmessage in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|