BObookingexperts
Amenities

PATCH amenity

Changed on

Updates the amenity for the given ID

patch/v3/amenities/{id}

Request

Path parameters

idstring required

Resource ID

Query parameters

fields[amenity]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": "amenity",
    "relationships": {
      "amenity_group": {
        "data": {
          "type": "amenity_group"
        }
      },
      "amenity_options": {
        "data": [
          {
            "type": "amenity_option"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "amenity_group"
    }
  ]
}

Response

AmenityResponse

Example response

{
  "data": {
    "id": "1",
    "type": "amenity",
    "relationships": {
      "amenity_group": {
        "data": {
          "type": "amenity_group"
        }
      },
      "amenity_options": {
        "data": [
          {
            "type": "amenity_option"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "amenity_group"
    }
  ]
}

Changes