Sign in
latestOpenAPI 3.0.02026-08-2179137152.2 KB

2c65f8afd8b2

Messages

Fetch a message.

get/v2/messages/{id}

Path parameters

idinteger required

The message unqiue Id.

Response

A model representing the message.

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' | 'bot'

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.