Email Reply API Parameters

This table defines the parameters used by the Email Reply API.

Parameter name

Description

Notes

id

The alphanumeric ID of the social contact.

subject

The subject line of the email.

This is also available via the social contact as "title.

fromAddress

The email address in the reply-to header (if the reply-to header is present) or the email address of the sender.

This is also available via the social contact as "author".

toAddress

The email address of the Customer Collaboration Platform email feed (the address to which the email was sent).

ccAddress

The email address to which the email was cc'd by the sender or the agent.

bccAddress

The email address to which the email was bcc'd by the agent.

ReplyToAddress

The email address to which the email was replied to.

receivedTimestamp

The timestamp (long) to indicate when the mail server received the email.

This is also available via the social contact as "published date".

contentType

The content type of the email body.

Permitted values are text/plain or text/html.

body

The main body (text) of the email enclosed within a Character Data (CDATA) section.

Required for POST (create an email reply).

The other email reply parameters can be sent but only the body is used. All other information is retrieved from the social contact or from the mail server itself.

refDraftURL

The refURL to get the reply draft data (the draft email reply and agent-side attachments).

attachments

Meta information about attachments related to the email contact.

->outgoingAttachments

Details about attachments that agents upload in reply to a message from a customer.

->incomingAttachments

Details about attachments that are contained in the email message from the customer.

-->attachment

Details about one specific attachment. This parameter contains the following information:

  • name—the filename of the attachment

  • refURL—The URL to access the attachment

  • sizeBytes—The size of the attachment in bytes