SceniqDevelopers

archive_property

Archive a property (values on spots are preserved).

POST/v1/properties/{propertyDefId}/archive
MCP tool archive_propertyScope: writeStableSince 2026-09-17
Markdown

Removes the property from the editor and every filter. Stored spot values stay as inert legacy data. Keys are reserved forever.

curl -X POST "https://sceniq.earth/api/v1/properties/kh7v7h8st8cr913jb2kzb839yxjtpkdf/archive" \
  -H "Authorization: Bearer $SCENIQ_API_KEY"

Path parameters

  • propertyDefIdstring · property idrequired

    Id of the property definition.

Returns

200 OK with this object.

  • okbooleanrequired

    Always true: the write went through.

    Always true

  • propertyDefIdstring · property idrequired

    The property's id.

  • archivedbooleanrequired

    Always true: the property is archived.

    Always true

Response 200
{
  "ok": true,
  "propertyDefId": "kh7v7h8st8cr913jb2kzb839yxjtpkdf",
  "archived": true
}

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.