POST
/
communities
/
curl --location --request POST 'https://api.travtus.com/communities/' \
--header 'Authorization: bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Skyline Apartments",
  "community_external_ref": "SKY-APT-001",
  "description": "Modern apartment complex with panoramic city views",
  "timezone": "US/Eastern",
  "email_address": "[email protected]",
  "phone_number": "555-123-4567",
  "property_type": "residential",
  "status": "active",
  "website_address": "https://skylineapartments.com",
  "latitude": 40.7128,
  "longitude": -74.0060
}'
{
  "request_id": "7f5ce31c-39a1-42df-9182-4858b7d94c3d"
}

Example use cases

This endpoint allows you to create a new community with the specified properties:

  • Create a new property or building portfolio
  • Specify contact information, location, and other details for the community
  • Establish the foundation for further property management operations
Authorization
string
default:"none"
required

The authentication token for your request

Request Body

name
string
required

The name of the community.

community_external_ref
string
default:"none"

An external reference ID for the community (recommended for system integration).

description
string
default:"none"

A description of the community.

timezone
string
required

The timezone where the community is located (e.g., “US/Eastern”, “UTC”).

email_address
string
default:"none"

The primary contact email for the community.

phone_number
string
default:"none"

The primary contact number for the community.

property_type
string
default:"none"

The type of property (e.g., “residential”, “commercial”).

status
string
default:"none"

The current status of the community (e.g., “active”, “inactive”).

website_address
string
default:"none"

The website URL for the community.

latitude
number
default:"none"

The latitude coordinate of the community location.

longitude
number
default:"none"

The longitude coordinate of the community location.

Response

request_id
string

A unique identifier for tracking the 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 required fields
{
  "name": [
    "This field is required."
  ],
  "timezone": [
    "This field is required."
  ]
}

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 - 500

Internal server error
{
  "error": {
    "message": "An error occurred while creating the community."
  }
}
curl --location --request POST 'https://api.travtus.com/communities/' \
--header 'Authorization: bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Skyline Apartments",
  "community_external_ref": "SKY-APT-001",
  "description": "Modern apartment complex with panoramic city views",
  "timezone": "US/Eastern",
  "email_address": "[email protected]",
  "phone_number": "555-123-4567",
  "property_type": "residential",
  "status": "active",
  "website_address": "https://skylineapartments.com",
  "latitude": 40.7128,
  "longitude": -74.0060
}'
{
  "request_id": "7f5ce31c-39a1-42df-9182-4858b7d94c3d"
}