BObookingexperts
Owners

PATCH owner

Changed on

Update an existing owner.

patch/v3/administrations/{administration_id}/owners/{id}

Request

Path parameters

administration_idstring required

Administration ID

idstring required

Resource ID

Query parameters

fields[owner]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "owner",
    "relationships": {
      "primary_contact": {
        "data": {
          "type": "contact"
        }
      },
      "contacts": {
        "data": [
          {
            "type": "contact"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "contact",
      "attributes": {
        "title": "mr",
        "country_code": "NL"
      },
      "relationships": {
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        }
      }
    }
  ]
}

Response

OwnerResponse

Example response

{
  "data": {
    "id": "1",
    "type": "owner",
    "attributes": {
      "title": "mr",
      "locale": "cs",
      "country_code": "NL"
    },
    "relationships": {
      "primary_contact": {
        "data": {
          "type": "contact"
        }
      },
      "contacts": {
        "data": [
          {
            "type": "contact"
          }
        ]
      },
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "active_inventory_objects": {
        "data": [
          {
            "type": "inventory_object"
          }
        ]
      },
      "owner_guests": {
        "data": [
          {
            "type": "owner_guest"
          }
        ]
      },
      "active_rentable_identities": {
        "data": {
          "type": "rentable_identity"
        }
      },
      "labels": {
        "data": [
          {
            "type": "label"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "contact",
      "attributes": {
        "title": "mr",
        "country_code": "NL"
      },
      "relationships": {
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        }
      }
    }
  ]
}

Changes