Sign in
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' | '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.

Changes

Changed in 3 of the 7 revisions of this API.41

  • 00db66c4418121See the full diff
    • ●

      added the new bot enum value to the allOf[subschema #2]/from_role response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pik_pak_go enum value to the allOf[subschema #2]/thread/allOf[subschema #2]/channel response property for the response status 200

      response-property-enum-value-added

    • ○

      api operation id Messages_Post removed and replaced with post-messages

      api-operation-id-removed

  • 8856ba6a1b761See the full diff
    • ●

      added the new trip_skip enum value to the allOf[subschema #2]/thread/allOf[subschema #2]/channel response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 807ad599634d1See the full diff
    • ●

      added the new inhaven enum value to the allOf[subschema #2]/thread/allOf[subschema #2]/channel response property for the response status 200

      response-property-enum-value-added