Message - Create/Update

Create or update a message. Exclude hash and id to create, include hash to update.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A system generated numerical id for the item. Cannot be altered.

string

A system generated unique id in the form of a hash to obscure numerical id.

string
deprecated

DEPRECATED. No longer in use.

string

The id of the associated conversation.

string

The id of the associated user who created the message.

string

The name of the msg for reference.

string

The type of message whether text message or email. EXAMPLES: sms,email

string

If email, the email address the message will appear to be from.

string

If email, the name of the person whom the message comes from.

string
deprecated

DEPRECATED. The email address the message is sent to. Messages now require a conversation to link to a contact or group.

string

If email, the subject line of the email. May contain message variables.

string

If email, the template to use for embedding message into.

string

The content of the message. May contain message variables filled before sending.

string
deprecated

DEPRECATED. No longer in use. Mime type of the media file being attached.

string

The id of the associated file attached to the message.

string
deprecated

DEPRECATED. The URL of the file being attached to the message. Use file_id instead.

string

A unique identifier to links messages together for filtering duplicates.

string

Flag indicating whether the message was incoming or outgoing.

string

Flag indicating the message was sent by the system and handed off to the provider.

string

An identifier used by the system to batch messages together for sending. Messages are batched every 30 seconds.

string

The id of the associated connection. Only applies to text messages being sent via a phone number.

string

Flag indicating an automated process on the account sent the message.

string

Date when the message will send.

string

Date indicating when the message was last modified.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json