Skip to main content
PATCH
/
v1
/
properties
/
{property_id}
Update Property
curl --request PATCH \
  --url https://api.trellistech.com/v1/properties/{property_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "address": "<string>",
  "city": "<string>",
  "country": "<string>",
  "bedrooms": 123,
  "bathrooms": 123,
  "max_guests": 123,
  "status": "<string>",
  "custom_fields": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "address": "<string>",
  "city": "<string>",
  "country": "<string>",
  "bedrooms": 123,
  "bathrooms": 123,
  "max_guests": 123,
  "status": "<string>",
  "custom_fields": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}
Updates the specified property by setting the values of the parameters passed. Any parameters not provided will remain unchanged.

​
Path Parameters

​
property_id
string
required
The unique identifier of the property to update.

​
Body Parameters

​
name
string
Display name of the property.
​
address
string
Full street address.
​
city
string
City name.
​
country
string
Country code (ISO 3166-1 alpha-2).
​
bedrooms
integer
Number of bedrooms.
​
bathrooms
number
Number of bathrooms.
​
max_guests
integer
Maximum guest capacity.
​
status
string
Property status. One of: ACTIVE, INACTIVE, ONBOARDING, LEAD, PAUSED, CHURNED.
​
custom_fields
object
Key-value pairs for custom fields configured in your workspace.

​
Example Request

curl -X PATCH \
  -H "Authorization: Bearer trls_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sunset Villa Deluxe",
    "max_guests": 10,
    "status": "ACTIVE"
  }' \
  "https://api.trellistech.com/v1/properties/a1b2c3d4-5678-9abc-def0-123456789abc"

​
Response

Returns the updated property object with all fields.
​
id
string
Unique identifier for the property.
​
name
string
Display name of the property.
​
address
string
Full street address.
​
city
string
City name.
​
country
string
Country code (ISO 3166-1 alpha-2).
​
bedrooms
integer
Number of bedrooms.
​
bathrooms
number
Number of bathrooms (supports half baths, e.g., 2.5).
​
max_guests
integer
Maximum guest capacity.
​
status
string
Current property status.
​
custom_fields
object
Key-value pairs for custom fields configured in your workspace.
​
created_at
string
ISO 8601 timestamp of when the property was created.
​
updated_at
string
ISO 8601 timestamp of the last update.

​
Example Response

200
{
  "id": "a1b2c3d4-5678-9abc-def0-123456789abc",
  "name": "Sunset Villa Deluxe",
  "address": "123 Ocean Drive",
  "city": "Miami Beach",
  "country": "US",
  "bedrooms": 3,
  "bathrooms": 2.5,
  "max_guests": 10,
  "status": "ACTIVE",
  "custom_fields": {
    "cleaning_fee": 150,
    "pet_policy": "Dogs allowed under 30 lbs"
  },
  "created_at": "2025-06-15T10:30:00Z",
  "updated_at": "2026-04-05T09:15:00Z"
}

​
Error Responses

404
{
  "error": {
    "code": "not_found",
    "message": "No property found with the specified ID."
  }
}
400
{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'status' parameter must be one of: ACTIVE, INACTIVE, ONBOARDING, LEAD, PAUSED, CHURNED."
  }
}
401
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}