Update a property.

PATCH

/properties/{id}

const url = 'https://api-us.suiteop.com/api/v1/properties/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"data":{"bathroomCount":1,"bedCount":1,"bedroomCount":1,"checkInDescriptionId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","city":"example","codeDisplay":"dynamic","codeEntryKey":"example","codeValidationKey":"example","countryCode":"example","coverImageUrl":"example","defaultCheckInHour":1,"defaultCheckOutHour":1,"descriptionId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","formattedAddress":"example","groupCodeDisplay":"dynamic","groupCodeEntryKey":"example","groupCodeValidationKey":"example","hasCheckInInstructionTimer":true,"hideTimerHours":1,"houseRulesId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","internalAccessNotes":"example","isAddressHidden":true,"isBackupSwapDisabled":true,"isBookable":true,"isCodeOverrideFixed":true,"isInspectionRequired":true,"latitude":1,"longitude":1,"maxGuests":1,"name":"example","nickname":"example","postalCode":"example","propertyGroupId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","reviewRequestUrl":"https://example.com","state":"example","streetAddress":"example","timezone":"example","unitNumber":"example","wifiName":"example","wifiPassword":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api-us.suiteop.com/api/v1/properties/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "data": { "bathroomCount": 1, "bedCount": 1, "bedroomCount": 1, "checkInDescriptionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "city": "example", "codeDisplay": "dynamic", "codeEntryKey": "example", "codeValidationKey": "example", "countryCode": "example", "coverImageUrl": "example", "defaultCheckInHour": 1, "defaultCheckOutHour": 1, "descriptionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "formattedAddress": "example", "groupCodeDisplay": "dynamic", "groupCodeEntryKey": "example", "groupCodeValidationKey": "example", "hasCheckInInstructionTimer": true, "hideTimerHours": 1, "houseRulesId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "internalAccessNotes": "example", "isAddressHidden": true, "isBackupSwapDisabled": true, "isBookable": true, "isCodeOverrideFixed": true, "isInspectionRequired": true, "latitude": 1, "longitude": 1, "maxGuests": 1, "name": "example", "nickname": "example", "postalCode": "example", "propertyGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reviewRequestUrl": "https://example.com", "state": "example", "streetAddress": "example", "timezone": "example", "unitNumber": "example", "wifiName": "example", "wifiPassword": "example" } }'

Update property fields (name, address, capacity, WiFi, codes, flags).

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

application/json

object

data

required

object

bathroomCount

number

bedCount

integer

<= 9007199254740991

bedroomCount

integer

<= 9007199254740991

checkInDescriptionId

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

city

string

codeDisplay

Any of:

string
null

string

Allowed values: dynamic fixed import

codeEntryKey

Any of:

string
null

string

codeValidationKey

Any of:

string
null

string

<= 8 characters

countryCode

string

<= 2 characters

coverImageUrl

Any of:

string
null

string

defaultCheckInHour

Any of:

integer
null

integer

<= 23

defaultCheckOutHour

Any of:

integer
null

integer

<= 23

descriptionId

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

formattedAddress

string

groupCodeDisplay

Any of:

string
null

string

Allowed values: dynamic fixed import

groupCodeEntryKey

Any of:

string
null

string

groupCodeValidationKey

Any of:

string
null

string

<= 8 characters

hasCheckInInstructionTimer

boolean

hideTimerHours

Any of:

integer
null

integer

<= 9007199254740991

houseRulesId

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

internalAccessNotes

Any of:

string
null

string

isAddressHidden

boolean

isBackupSwapDisabled

boolean

isBookable

boolean

isCodeOverrideFixed

boolean

isInspectionRequired

boolean

latitude

number

longitude

number

maxGuests

integer

>= 1 <= 9007199254740991

name

string

>= 1 characters

nickname

string

postalCode

string

propertyGroupId

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

reviewRequestUrl

Any of:

string
null

string format: uri

state

string

streetAddress

string

timezone

string

unitNumber

string

wifiName

Any of:

string
null

string

wifiPassword

Any of:

string
null

string

Responses

200

Success.

application/json

object

data

required

Response payload.

object

averageRating

required

Any of:

number
null

number

bathroomCount

required

Any of:

number
null

number

bedCount

required

Any of:

number
null

number

bedroomCount

required

Any of:

number
null

number

city

required

Any of:

string
null

string

cleaningStatus

required

Any of:

string
null

string

countryCode

required

Any of:

string
null

string

coverImageUrl

required

Any of:

string
null

string

createdAt

required

string format: date-time

defaultCheckInHour

required

Any of:

number
null

number

defaultCheckOutHour

required

Any of:

number
null

number

formattedAddress

required

Any of:

string
null

string

hasCheckInInstructionTimer

required

boolean

hideTimerHours

required

Any of:

number
null

number

required

string

inspectionStatus

required

Any of:

string
null

string

internalAccessNotes

required

Any of:

string
null

string

isAddressHidden

required

boolean

isBackupSwapDisabled

required

boolean

isBookable

required

boolean

isDisabled

required

boolean

isInspectionRequired

required

boolean

latitude

required

Any of:

string
null

string

longitude

required

Any of:

string
null

string

maintenanceStatus

required

Any of:

string
null

string

maxGuests

required

Any of:

number
null

number

name

required

string

nickname

required

Any of:

string
null

string

postalCode

required

Any of:

string
null

string

propertyGroupId

required

Any of:

string
null

string

readinessStatus

required

Any of:

string
null

string

state

required

Any of:

string
null

string

streetAddress

required

Any of:

string
null

string

timezone

required

Any of:

string
null

string

unitNumber

required

Any of:

string
null

string

updatedAt

required

string format: date-time

wifiName

required

Any of:

string
null

string

meta

required

Response metadata present on every success response.

object

pagination

Present on list responses.

object

limit

required

Page size used for this request.

integer

offset

required

Number of items skipped.

integer

total

required

Total number of matching items (across all pages).

integer

requestId

required

Unique identifier for this request.

string

Example ^generated

{
  "data": {
    "averageRating": 1,
    "bathroomCount": 1,
    "bedCount": 1,
    "bedroomCount": 1,
    "city": "example",
    "cleaningStatus": "example",
    "countryCode": "example",
    "coverImageUrl": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "defaultCheckInHour": 1,
    "defaultCheckOutHour": 1,
    "formattedAddress": "example",
    "hasCheckInInstructionTimer": true,
    "hideTimerHours": 1,
    "id": "example",
    "inspectionStatus": "example",
    "internalAccessNotes": "example",
    "isAddressHidden": true,
    "isBackupSwapDisabled": true,
    "isBookable": true,
    "isDisabled": true,
    "isInspectionRequired": true,
    "latitude": "example",
    "longitude": "example",
    "maintenanceStatus": "example",
    "maxGuests": 1,
    "name": "example",
    "nickname": "example",
    "postalCode": "example",
    "propertyGroupId": "example",
    "readinessStatus": "example",
    "state": "example",
    "streetAddress": "example",
    "timezone": "example",
    "unitNumber": "example",
    "updatedAt": "2026-04-15T12:00:00Z",
    "wifiName": "example"
  },
  "meta": {
    "pagination": {
      "limit": 1,
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute for this API key.

X-RateLimit-Remaining

integer

Remaining requests in the current rate-limit window.

X-RateLimit-Reset

integer

Unix epoch seconds when the rate-limit window resets.

X-Request-Id

string

Unique identifier for this request (matches meta.requestId in the body).

400

application/json

ValidationError

Error envelope returned for HTTP 400 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: validation_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "validation_error"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

401

application/json

AuthenticationError

Error envelope returned for HTTP 401 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: authentication_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "authentication_error"
  }
}

Headers

X-Request-Id

string

Request correlation id (also in meta.requestId).

403

application/json

AuthorizationError

Error envelope returned for HTTP 403 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: authorization_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "authorization_error"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

404

application/json

NotFoundError

Error envelope returned for HTTP 404 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: not_found_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "not_found_error"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

409

application/json

ConflictError

Error envelope returned for HTTP 409 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: conflict_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "conflict_error"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

422

application/json

BusinessRuleError

Error envelope returned for HTTP 422 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: business_rule_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "business_rule_error"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

429

application/json

RateLimitError

Error envelope returned for HTTP 429 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: rate_limit_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "rate_limit_error"
  }
}

Headers

Retry-After

integer

Number of seconds to wait before retrying.

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

500

application/json

InternalError

Error envelope returned for HTTP 500 responses.

object

error

required

object

code

required

Machine-readable error code.

string

details

Optional structured details (omitted when undefined).

object

key

additional properties

any

message

required

Human-readable error message.

string

type

required

Error type.

string

Allowed values: internal_error

meta

required

object

requestId

required

string

Example

{
  "error": {
    "type": "internal_error"
  }
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute.

X-RateLimit-Remaining

integer

Remaining requests in the current window.

X-RateLimit-Reset

integer

Unix epoch seconds when the window resets.

X-Request-Id

string

Request correlation id (also in meta.requestId).

Update a property.

Authorizations

Parameters

Path Parameters

Request Body required

Responses

200

Example generated

Headers

400

Example

Headers

401

Example

Headers

403

Example

Headers

404

Example

Headers

409

Example

Headers

422

Example

Headers

429

Example

Headers

500

Example

Headers

Request Body^required

Example ^generated