Guests

Partially update a guest.

Changed on
patch/v2/guests/{id}

Request

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

Path parameters

idinteger required

The Id of the guest to update.

Request body

idinteger

The ID of this record.

tagsstring[]

A collection of tag names.

first_namestring
is_bannedboolean
last_namestring
notesstring
opt_out_marketing_emailboolean
opt_out_marketing_smsboolean
opt_out_transactional_smsboolean
preferred_languagestring

The guest's preferred language as a BCP 47 tag ("es" or "es-MX"). Values are normalized on save; unrecognized tags are rejected. Filled automatically from the booking channel when it shares one.

Response

A model representing the updated guest.

idinteger

The ID of this record.

tagsstring[]

A collection of tag names.

first_namestring
is_bannedboolean
last_namestring
notesstring
opt_out_marketing_emailboolean
opt_out_marketing_smsboolean
opt_out_transactional_smsboolean
preferred_languagestring

The guest's preferred language as a BCP 47 tag ("es" or "es-MX"). Values are normalized on save; unrecognized tags are rejected. Filled automatically from the booking channel when it shares one.

Changes

    • info

      added the new optional request property /

    • 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

    • info

      added the optional property / to the 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