ONontraport
messages

This will update an existing Message

put/message

Request

  • Base URL
    https://api.ontraport.com/1
  • Auth
    none declared

Request body application/x-www-form-urlencoded

idinteger required

ID of the Message to be updated.

objectID7

Object Type ID.

transactional_email0 | 1

Is this message transactional email? Transactional email is NOT marketing email. It is email that delivers a product, an invoice, a request for payment for a purchase already made, or other messaging having to do with an existing client relationship. It is not to promote new stuff to an existing client. When you set this flag to 1, the email will be sent even if a contact has already unsubscribed. Because of this, if you send it to someone who isn't a client and who has unsubscribed, you will be breaking CAN-SPAM and other anti-spam laws. This is your responsibility. In addition, Ontraport can and will suspend your account should we discover marketing messages in emails that you have marked as Transactional Emails.

aliasstring

Message alias.

namestring

Name of your Message.

subjectstring

Subject to be sent with the Message.

from'owner' | 'custom' | '<staff user ID>'

Who will this Message come from? If not <b>owner</b> or <b>custom</b>, this field can contain the Staff user ID to send the Message from.

send_out_namestring

Name to be used in the 'Message From' field when the <b>from</b> field is set to <b>custom</b>.

reply_to_emailstring

The email address to use as the reply-to in the Message.

plaintextstring

The plain text version of your Message (for Email messages). For SMS Messages, this is the content that will be sent.

send_fromstring

Custom Send-from email address. Leave this empty to use your default email address. Otherwise, this must be a validated send-from email address.

send_tostring

Only used with SMS Messages or Custom Objects. Select the field to use when there may be a parent or child relationship to the Object type given in <b>object_type_id</b>. The default for SMS Message is <b>sms_number.</b>

message_bodystring

Use this for Legacy Email Messages only. This is the HTML content of the Message.

resourcestring

For ONTRAmail Messages only; this is the content of the message. Note that this can be extremely complex, so you should start by inspecting the resource that is sent when saving a Message from inside the App. For SMS Messages, use the plaintext field for content.

task_datastring

Use this only for Task Messages. This is the content of the Message.

due_dateinteger

Use this only for Task Messages. This is the number of days after assignment this Task is due.

task_ownerinteger

Use this only for Task Messages. This is the Staff user ID of the Task owner.

task_forminteger

Use this only for Task Messages. This is the optional Form ID to be filled when the Task is completed. This form must already exist.

Response

Message successfully updated

codeinteger required
dataobject required
account_idinteger required

Changes

No recorded changes to this operation across all 5 revisions of this API.