Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Messages

Create a new message.

post/v2/messages

Request body

attachment_urlstring nullable

A publicly accessible URL to a file to be attached to the message. Images only. Maximum 5 MB.

bodystring nullable

The message text.

thread_idinteger

The ID of the thread on which this message should be posted.

Response

A model representing the message created.

idinteger

The ID of this record.

attachment_urlsstring[]

A list of URLs for downloading attachments to this message. URLs are temporary and will expire after a set time.

bodystring

The message text.

date_utcstring date-time

The date this message was sent or received.

from_contact_idinteger

The ID of the guest or contact who wrote this message.

from_role'owner' | 'guest' | 'co_host' | 'support' | 'other' | 'cotraveler' | 'third_party_booker'

The role of the contact who wrote a message.

is_draftboolean

Indicates an unsent draft.

removed_utcstring date-time nullable

The date this message was removed.

thread_idinteger

The ID of the thread on which this message was posted.