# update_property

Relabel a property or manage its options.

`PATCH /v1/properties/{propertyDefId}` · MCP tool `update_property` · scope `write` · stable · since 2026-09-17

Key and kind are immutable (a type change is a new property). options is the full desired list: entries with an id relabel, reorder or archive an existing option; entries without an id are new. Existing option ids can never be removed, only archived.

## Path parameters

- `propertyDefId` (string, required): Id of the property definition (from list_properties).

## Body parameters

- `filterable` (boolean, optional): Ignored: the kind decides (see create_property).
- `label` (string, optional): Display label, 1 to 80 characters.
- `numUnit` (string, optional): Unit label for number properties (m, km, USD); refused on other kinds.
- `options` (array of objects, optional): Full list, at most 100: [{ id?, label, order?, archived? }].
  - `id` (string, optional): An existing option's id, to relabel, reorder or archive it. Leave it out for a new option; the server mints its id. Every existing id must stay in the list.
  - `label` (string, required): Option label, 1 to 80 characters.
  - `order` (number, optional): Display position (ascending). Absent keeps an existing option's position; a new option takes its index in this list.
  - `archived` (boolean, optional): true retires the option: filters drop it at once, stored spot values keep it. false brings it back; spots already holding it return to its filter once their customValues are written again. Absent keeps the current state.
- `placeholder` (string, optional): Editor placeholder text, stored as sent.
- `required` (boolean, optional): Whether every spot must carry a value. Checked when a spot is created and whenever a spot's customValues are sent.

## Returns

200.

- `ok` (boolean, required): Always true: the write went through. Always `true`.
- `propertyDefId` (string, required): The property's id.
- `schemaVersion` (number, required): The guide's property schema version after the change.

## Examples

### Add an option; the existing ones keep their ids

```bash
curl -X PATCH "https://sceniq.earth/api/v1/properties/kh75t2w9q4r6y8v0j1p3p5a7s9d1f3g5" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "options": [
    {
      "id": "sunrise",
      "label": "Sunrise"
    },
    {
      "id": "morning",
      "label": "Morning"
    },
    {
      "id": "midday",
      "label": "Midday"
    },
    {
      "id": "sunset",
      "label": "Sunset"
    },
    {
      "label": "Night"
    }
  ]
}'
```

MCP `tools/call`:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_property",
    "arguments": {
      "propertyDefId": "kh75t2w9q4r6y8v0j1p3p5a7s9d1f3g5",
      "options": [
        {
          "id": "sunrise",
          "label": "Sunrise"
        },
        {
          "id": "morning",
          "label": "Morning"
        },
        {
          "id": "midday",
          "label": "Midday"
        },
        {
          "id": "sunset",
          "label": "Sunset"
        },
        {
          "label": "Night"
        }
      ]
    }
  }
}
```

Response 200:

```json
{
  "ok": true,
  "propertyDefId": "kh75t2w9q4r6y8v0j1p3p5a7s9d1f3g5",
  "schemaVersion": 7
}
```

### Relabel a property and one of its options; stored values stay

```bash
curl -X PATCH "https://sceniq.earth/api/v1/properties/kh7b3n5m7q9w1e3r5t7y9v1j3p5p7a9s" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Crowds in summer",
  "options": [
    {
      "id": "quiet",
      "label": "Quiet"
    },
    {
      "id": "busy",
      "label": "Busy"
    },
    {
      "id": "packed",
      "label": "Very busy"
    }
  ]
}'
```

MCP `tools/call`:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_property",
    "arguments": {
      "propertyDefId": "kh7b3n5m7q9w1e3r5t7y9v1j3p5p7a9s",
      "label": "Crowds in summer",
      "options": [
        {
          "id": "quiet",
          "label": "Quiet"
        },
        {
          "id": "busy",
          "label": "Busy"
        },
        {
          "id": "packed",
          "label": "Very busy"
        }
      ]
    }
  }
}
```

Response 200:

```json
{
  "ok": true,
  "propertyDefId": "kh7b3n5m7q9w1e3r5t7y9v1j3p5p7a9s",
  "schemaVersion": 8
}
```

## Errors

- `invalid_argument` (400): A required field is missing, a field is unknown, or a value does not match its type (the Convex validator's path and value are in the message).
- `invalid_request` (400): A writer refused a value: a map link on a host that is not allowed, a title that is too long, a date that does not exist, too many items in a list. The message is the writer's own sentence.
- `unauthenticated` (401): The request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
- `invalid_api_key` (401): The key is unknown, revoked or expired.
- `api_scope_required` (403): A read-only key called a write operation, or a key without the publish option called publish_changes.
- `forbidden` (403): The key belongs to a creator account that is no longer active.
- `not_found` (404): The id does not exist or belongs to another creator. The two answers are identical on purpose, so ids never reveal what exists.
- `payload_too_large` (413): A JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
- `rate_limited` (429): Over a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
- `internal_error` (500): An unexpected failure. The message is hidden on purpose.

Reference: https://developers.sceniq.earth/reference/update_property