SceniqDevelopers

set_route_facilities

Replace the places a route uses.

PUT/v1/routes/{routeId}/facilities
MCP tool set_route_facilitiesScope: writeStableSince 2026-09-17
Markdown

Full replacement: [{ facilityId, order }].

curl -X PUT "https://sceniq.earth/api/v1/routes/kx7f2h8j4k0k6z2x8c4v0b6n2m8q4w0e/facilities" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "facilities": [
    {
      "facilityId": "km7d4f6g8h0j2k4k6z8x0c2v4b6n8m0q",
      "order": 1024
    }
  ]
}'

Path parameters

  • routeIdstring · route idrequired

    Id of the route.

Body parameters

  • facilitiesarray of objectsrequired

    Ordered [{ facilityId, order }], at most 50.

    Show 2 fields
    • facilityIdstring · place idrequired

      A place of this guide (from list_facilities), listed once.

    • ordernumberrequired

      The place's position on the route (ascending, any number).

Returns

200 OK with this object.

  • okbooleanrequired

    Always true: the write went through.

    Always true

  • routeIdstring · route idrequired

    The route's id.

  • edgesnumberrequired

    How many links the list now holds.

Response 200
{
  "ok": true,
  "routeId": "kx7f2h8j4k0k6z2x8c4v0b6n2m8q4w0e",
  "edges": 1
}

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.