SceniqDevelopers

update_property

Relabel a property or manage its options.

PATCH/v1/properties/{propertyDefId}
MCP tool update_propertyScope: writeStableSince 2026-09-17
Markdown

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.

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"
    }
  ]
}'

Path parameters

  • propertyDefIdstring · property idrequired

    Id of the property definition (from list_properties).

Body parameters

  • filterablebooleanoptional

    Ignored: the kind decides (see create_property).

  • labelstringoptional

    Display label, 1 to 80 characters.

  • numUnitstringoptional

    Unit label for number properties (m, km, USD); refused on other kinds.

  • optionsarray of objectsoptional

    Full list, at most 100: [{ id?, label, order?, archived? }].

    Show 4 fields
    • idstringoptional

      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.

    • labelstringrequired

      Option label, 1 to 80 characters.

    • ordernumberoptional

      Display position (ascending). Absent keeps an existing option's position; a new option takes its index in this list.

    • archivedbooleanoptional

      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.

  • placeholderstringoptional

    Editor placeholder text, stored as sent.

  • requiredbooleanoptional

    Whether every spot must carry a value. Checked when a spot is created and whenever a spot's customValues are sent.

Returns

200 OK with this object.

  • okbooleanrequired

    Always true: the write went through.

    Always true

  • propertyDefIdstring · property idrequired

    The property's id.

  • schemaVersionnumberrequired

    The guide's property schema version after the change.

Response 200
{
  "ok": true,
  "propertyDefId": "kh75t2w9q4r6y8v0j1p3p5a7s9d1f3g5",
  "schemaVersion": 7
}

Errors

Every error is { error: { code, message } }. Act on the code.

  • 400invalid_argumentA 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).
  • 400invalid_requestA 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.
  • 401unauthenticatedThe request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
  • 401invalid_api_keyThe key is unknown, revoked or expired.
  • 403api_scope_requiredA read-only key called a write operation, or a key without the publish option called publish_changes.
  • 403forbiddenThe key belongs to a creator account that is no longer active.
  • 404not_foundThe id does not exist or belongs to another creator. The two answers are identical on purpose, so ids never reveal what exists.
  • 413payload_too_largeA JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
  • 429rate_limitedOver a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
  • 500internal_errorAn unexpected failure. The message is hidden on purpose.