Create a conversation

Updated: October 29, 2026

POST/property/{connection_id}/conversation

Creates a PropertyConversation. Provide the unified PropertyConversation fields in the request body; they are mapped to the provider's API. Returns the created PropertyConversation.

Parameters

Payload

idstring

unique identifier for the conversation

created_atdate-time

when the conversation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

when the conversation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

listing_idstring

pointer to the Property Listing this conversation is about

reservation_idstring

pointer to the Property Reservation this conversation is about

guest_idstring

pointer to the Property Guest in this conversation

guest_namestring

the guest full name

guest_emailstring

the guest email address

guest_phonestring

the guest telephone number

sourcestring

the channel the conversation happens on, eg. Airbnb, email or SMS

is_unreadboolean

whether the conversation has unread messages

messages array

the messages in this conversation, oldest first

metadata array

custom field values

raw

raw data from the integration

Returns

PropertyConversation

Response 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

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'POST',
  url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/conversation',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.property.createPropertyConversation({ connectionId, propertyConversation: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/conversation',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/property/5de520f96e439b002043d8dc/conversation?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/property/5de520f96e439b002043d8dc/conversation?fields=&raw=

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/property/5de520f96e439b002043d8dc/conversation?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/property/5de520f96e439b002043d8dc/conversation?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/property/5de520f96e439b002043d8dc/conversation?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request POST \
  --url 'https://api.unified.to/property/5de520f96e439b002043d8dc/conversation?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?