Conversation data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | unique identifier for the conversation |
created_at | string (date-time) | No | when the conversation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | when the conversation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
listing_id | string | No | pointer to the Property Listing this conversation is about |
reservation_id | string | No | pointer to the Property Reservation this conversation is about |
guest_id | string | No | pointer to the Property Guest in this conversation |
guest_name | string | No | the guest full name |
guest_email | string | No | the guest email address |
guest_phone | string | No | the guest telephone number |
source | string | No | the channel the conversation happens on, eg. Airbnb, email or SMS |
is_unread | boolean | No | whether the conversation has unread messages |
messages | PropertyMessage[] | No | the messages in this conversation, oldest first |
messages[].id | string | No | unique identifier for the message |
messages[].created_at | string (date-time) | No | when the message was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
messages[].updated_at | string (date-time) | No | when the message was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
messages[].message | string | No | the message body as plain text |
messages[].subject | string | No | the message subject |
messages[].sender_type | enum | No | whether the guest, host or system sent the message Values: GUEST, HOST, SYSTEM |
messages[].sender_name | string | No | the name of the sender |
messages[].is_automatic | boolean | No | whether the message was sent automatically |
messages[].is_unread | boolean | No | whether the message has not been read |
messages[].attachments | PropertyAttachment[] | No | files attached to the message |
messages[].attachments[].id | string | No | unique identifier for the attachment |
messages[].attachments[].name | string | No | the attachment file name |
messages[].attachments[].download_url | string | No | URL to download the attachment |
messages[].attachments[].content_type | string | No | the attachment MIME type |
metadata | PropertyMetadata[] | No | custom field values |
metadata[].id | string | No | the custom field identifier |
metadata[].slug | string | No | the custom field key |
metadata[].value | object | No | the custom field value |
metadata[].namespace | string | No | the scope or origin of the custom field |
metadata[].format | enum | No | the data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | additional data about the custom field |
Are we missing anything? Let us know
Was this page helpful?