# Change or archive a custom amenity

`PATCH /lodging/custom-amenities/{id}` · Rivier · bookings

Change or archive a custom amenity.

- Scope: bookings:admin
- Mcp: rivier_lodging_custom_amenity_update
- Sdk: bookings.customAmenity.update
- Cli: bookings custom amenity update

## Parameters

- `id` (path, required), string

## Request body

`application/json`

```json
{
  "type": "object",
  "properties": {
    "icon": {
      "type": "string",
      "pattern": "^[A-Za-z0-9]{1,40}$"
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "propertyNames": {
        "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$"
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ]
    }
  },
  "additionalProperties": false
}
```

## Responses

- `200`: Success
- `400`: The request was malformed
- `401`: No valid credential
- `403`: The credential lacks the scope, origin or address
- `429`: Over the key's rate limit; see Retry-After

## Example

```sh
curl -X PATCH 'https://api.rivier.ai/lodging/custom-amenities/{id}' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "icon": "string",
  "labels": {},
  "status": "active"
}'
```