Messages: Message object
Attributes available on a Message object.
Attribute | Details | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
integer
|
Unique identifier for the object. |
||||||||||||||||||||||
object
string
|
String representing the object's type. Objects of the same type share the same value. Value is |
||||||||||||||||||||||
date_created
date_time
|
Date the object was created. The date is returned in the ISO-8061 format. |
||||||||||||||||||||||
event_submission
integer
|
ID of the event submission that is associated with the message. |
||||||||||||||||||||||
file
integer, hash
|
ID of the zip file attached to the message. If expanded, the field will be a hash describing the file.
Child Attributes
|
||||||||||||||||||||||
form
integer, hash
|
ID of the form the message was submitted from. If expanded, the field will be a hash describing the file.
Child Attributes
|
||||||||||||||||||||||
form_submission
hash
|
An object that contains the form field data that was submitted as part of the message.
Child Attributes
|
||||||||||||||||||||||
message_tracking_number
string
|
Unique string identifying the message. |
||||||||||||||||||||||
message_type
string
|
The type of message. Possible values are |
||||||||||||||||||||||
online_proof
integer
|
ID of the online proof that is associated with the message. |
||||||||||||||||||||||
order
integer, order object
|
ID of the order that is associated with the message. If expanded, the field will be an order object.
|
||||||||||||||||||||||
payment_transactions
list
|
A list of payments made for this message.
Child Attributes
|
||||||||||||||||||||||
portal
integer, hash
|
ID of the portal the message was submitted from. If expanded, the field will be a hash describing the portal.
Child Attributes
|
||||||||||||||||||||||
user
integer, hash
|
ID of the user who submitted the message. If expanded, the field will be a hash describing the user.
Child Attributes
|
{ "id": 45, "object": "message", "date_created": "2018-05-30T19:30:58+00:00", "event_submission": 0, "file": { "object": "file", "id": 8425954, "filename": "file_upload_20180530223639.zip", "url": "http://example-website-domain.com/file_download/47f4813c-eff0-46a7-9969-62a20d969e71", "expires": "2018-06-29T22:36:39+00:00" }, "form": { "object": "form", "id": 10119111, "title": "General Contact" }, "form_submission": { "object": "form_submission", "fields": { "f10119112": { "object": "form_submission_field", "id": "f10119112", "field_type": "name", "label": "Your Name", "values": { "prefix": "", "first": "John", "middle": "", "last": "Doe", "suffix": "" }, "formatted_value": "John Doe" }, "f10119098": { "object": "form_submission_field", "id": "f10119098", "field_type": "email", "label": "E-mail Address", "values": { "submitted_value": "john.doe@example.com", "display_value": "" }, "formatted_value": "john.doe@example.com" }, "f10119100": { "object": "form_submission_field", "id": "f10119100", "field_type": "upload", "label": "File #1", "values": { "data": [ { "filename": "test-image.jpeg (3 kb)" } ] }, "formatted_value": "test-image.jpeg (3 kb)" } } }, "message_tracking_number": "4415297e3af8c", "message_type": "general_contact", "online_proof": 0, "order": null, "payment_transactions": { "object": "list", "data": [ { "object": "payment_transaction", "id": 3, "date_created": "2018-05-30T19:30:58+00:00", "transaction_type": "payment", "payment_type": "credit_card", "amount": 66298, "transaction_id": "89d5656137894fb1afd1ad432977965a", "transaction_status": "captured", "test_mode": false, "currency": "usd", "is_recurring": false } ] }, "portal": { "object": "portal", "id": 1147329, "title": "XYZ Corporation" }, "user": { "object": "website_user", "id": 11, "username": "xyzcorp", "third_party_identifier": "" } }