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
community_id
or community_external_ref
, and include at least one field to update.
Header
The authentication token for your request
Request Body
The unique identifier for the community to update.
Either this or
community_external_ref
is required.The external reference ID for the community to update.
Either this or
community_id
is required.The updated name of the community.
An updated description of the community.
The updated timezone where the community is located.
The updated primary contact email for the community.
The updated primary contact number for the community.
The updated type of property.
The updated status of the community.
The updated website URL for the community.
The updated latitude coordinate of the community location.
The updated longitude coordinate of the community location.
Response
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 - 400Missing community identifier
No update fields provided
Invalid field value
Invalid Authorization header bearer token value
Community not found
Internal server error