Fields

Partially update a field.

Changed on
patch/v2/fields/{id}

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/fields/{id}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idinteger required

The Id of the field to update.

Request body

idinteger

The ID of this record.

entity_idinteger
entity_type'booking' | 'property' | 'quote' | 'user' | 'guest' | 'owner'

Entity types that support custom fields. This is a subset of EntityType enum values for entities that implement IFieldableEntity. Values must match the corresponding EntityType enum values to allow for translation.

field_definition_idinteger
valuestring

Response

A model representing the updated field.

idinteger

The ID of this record.

entity_idinteger
entity_type'booking' | 'property' | 'quote' | 'user' | 'guest' | 'owner'

Entity types that support custom fields. This is a subset of EntityType enum values for entities that implement IFieldableEntity. Values must match the corresponding EntityType enum values to allow for translation.

field_definition_idinteger
valuestring

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

      added subschema #2 to the request body allOf list

    • warning

      removed subschema #1 subschema #2 from the request body allOf list