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 message.
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.

Includable

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 file.
expires
date_time

Date the file will be deleted and no longer be available for download. The date is returned in the ISO-8061 format.
filename
string

Filename for the uploaded file.
url
string

URL to download the file.
form
integer, hash

ID of the form the message was submitted from. If expanded, the field will be a hash describing the file.

Includable

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 form.
title
string

Title of the form.
form_submission
hash

An object that contains the form field data that was submitted as part of the message.

Includable

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 form_submission_field.
field_type
string

The type of form field this data was submitted from (e.g., text, checkboxes, email, name).
formatted_value
string

The submitted value formatted as a string.
label
string

The form field label.
values
hash

The values submitted for this field. The attributes available in the hash will depend on the field type. For example, a text field will only have a submitted_value attribute, but a name field will have prefix, first, middle, last, and suffix.
message_tracking_number
string

Unique string identifying the message.
message_type
string

The type of message. Possible values are content_online_proof, enfocus_file_upload, event_management, file_transfer, file_transfer_form, general_contact, jobready, landing_page_conversion, online_estimate, online_order, online_payment, online_proof_form, prayer_request, system_notice.
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.

Includable

payment_transactions
list

A list of payments made for this message.

Includable

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 payment_transaction.
amount
integer

The amount of the payment, in cents.
currency
currency

Three-letter ISO currency code.
date_created
date_time

Date the object was created. The date is returned in the ISO-8061 format.
is_recurring
string

Indicates whether or not this is a recurring payment.
payment_type
string

How the payment was made. Possible values are ach, credit_card, and manual.
test_mode
boolean

A boolean indicating whether the payment was made in test mode.
transaction_id
string

Unique identifier for this payment that was generated by the payment processor.
transaction_status
string

Status of the transaction. Possible values are authorized, captured, and voided.
transaction_type
string

The type of payment transaction. Possible values are payment and credit.
portal
integer, hash

ID of the portal the message was submitted from. If expanded, the field will be a hash describing the portal.

Includable

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 portal.
title
string

Title of the portal.
user
integer, hash

ID of the user who submitted the message. If expanded, the field will be a hash describing the user.

Includable

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 website_user.
third_party_identifier
string

A custom field that can be used to tie this user to a user in an external system.
username
string

The user's username.