Difference between revisions of "API:Email:New"

From docs
Jump to: navigation, search
(Created page with "== API » New Email == '''URL:''' <nowiki>https://app.callproof.com/api/contact/email/messages/new/</nowiki> '''Method:''' POST '''Required Fields:''' * '''''api_k...")
 
(No difference)

Latest revision as of 13:02, 16 August 2017

API » New Email

URL: https://app.callproof.com/api/contact/email/messages/new/

Method: POST

Required Fields:

  • api_key[key] - API Key
  • api_key[secret] - API Key Secret
  • message_data[to_email_ids][] - Array of Email IDs to whom email sent
  • message_data[from] - Source Email ID from which email sent.
  • message_data[sent_date] - Email sent date/time (e.g. '2014-08-10 12:34:56')
  • message_data[subject] - Email subject
  • message_data[body][content_type] - Email data type ('text/plain', 'html')
  • message_data[body][content] - Email data i.e. content of message
  • message_data[message_id] - Unique message ID
  • message_data[account_id] - Account associate with callproof system


Optional Fields:

  • message_data[body][has_attachments] - If email contains attachment then '1' else '0'
  • message_data[body][attachments][] - Array of attachments
  • message_data[body][attachments][0][name] - Name of attachment file
  • message_data[body][attachments][0][file_data] - Base64 encoded file data


Data Returned:

  • results - Synced email message data
  • errors - Array of errors produced by the request
  • code - HTTP request status