Skip to main content
PATCH
/
communities
curl --location --request PATCH 'https://api.travtus.com/communities/' \
--header 'Authorization: bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "community_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "Skyline Apartments - East Tower",
  "description": "Updated luxury apartment complex with panoramic city views",
  "status": "inactive"
}'

{
  "request_id": "<string>"
}

​
Example use cases

This endpoint allows you to update details of an existing community:
  • Update contact information such as email or phone number
  • Change the community name, status, or description
  • Update location details or web presence information
You must identify the community to update with either community_id or community_external_ref, and include at least one field to update.
​
Authorization
string
default:"none"
required
The authentication token for your request

​
Request Body

​
community_id
string
default:"none"
The unique identifier for the community to update. Either this or community_external_ref is required.
​
community_external_ref
string
default:"none"
The external reference ID for the community to update. Either this or community_id is required.
​
name
string
default:"none"
The updated name of the community.
​
description
string
default:"none"
An updated description of the community.
​
timezone
string
default:"none"
The updated timezone where the community is located.
​
email_address
string
default:"none"
The updated primary contact email for the community.
​
phone_number
string
default:"none"
The updated primary contact number for the community.
​
property_type
string
default:"none"
The updated type of property.
​
status
string
default:"none"
The updated status of the community.
​
website_address
string
default:"none"
The updated website URL for the community.
​
latitude
number
default:"none"
The updated latitude coordinate of the community location.
​
longitude
number
default:"none"
The updated longitude coordinate of the community location.

​
Response

​
request_id
string
A unique identifier for tracking the update request. This ID can be used for support inquiries or tracking status.

​
Errors

Listed below are common errors that may be returned by the endpoint, along with their corresponding status code. Status Code - 400
Missing community identifier
{
  "non_field_errors": [
    "Either community_id or community_external_ref must be provided"
  ]
}
Status Code - 400
No update fields provided
{
  "non_field_errors": [
    "At least one field to update must be provided"
  ]
}
Status Code - 400
Invalid field value
{
  "email_address": [
    "Enter a valid email address."
  ]
}
Status Code - 401
Invalid Authorization header bearer token value
{
  "error": {
    "type": "invalid_authorization",
    "message": "The bearer token you have provided in the 'Authorization' header is invalid."
  }
}
Status Code - 404
Community not found
{
  "error": {
    "type": "community_not_found",
    "message": "There are no community records matching the information provided."
  }
}
Status Code - 500
Internal server error
{
  "error": {
    "message": "An error occurred while updating the community."
  }
}

curl --location --request PATCH 'https://api.travtus.com/communities/' \
--header 'Authorization: bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "community_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "Skyline Apartments - East Tower",
  "description": "Updated luxury apartment complex with panoramic city views",
  "status": "inactive"
}'