Update Mapbox Settings

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V81 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp"
  }
}

Close
PUT /mapbox/settings

Updates the server's Mapbox integration settings. Every field is optional; an omitted field keeps its stored value. In particular, omit api_key to keep the stored key.

After the merge, api_key, user and map_type must all be non-empty, and map_type must be one of the server's map_types. profile_default_threshold must be an integer of 0 or more, unless server_mapview_limit is negative.

Authorization

Same as GET /mapbox/settings: internal API clients only; COMPANY or SERVER users on a ZWS-integrated server, SERVER users only otherwise.

Headers

  • Authorization string

    e.g. Bearer {access_token}

application/json

Body Required

  • api_key string

    the Mapbox secret key; omit to keep the stored key

  • user string

    the Mapbox account user name

  • map_type string

    the default map type; one of map_types

  • profile_default_threshold integer

    the default map-view threshold for a new profile

Responses

  • 200 application/json

    OK - the settings were saved. The body is the updated settings, in the same shape as GET.

    Hide response attributes Show response attributes object
    • enabled boolean Required

      always true; a disabled server answers 409

    • user string Required

      the Mapbox account user name

    • api_key_last4 string | null Required

      the last four characters of the stored key; null when none is stored, "" when the key is four characters or shorter

    • map_type string Required

      the default map type

    • map_types array[string] Required

      the map types map_type may take

    • profile_default_threshold integer Required

      the default map-view threshold for a new profile

    • server_mapview_limit integer Required

      the server-wide map-view cap; negative means no cap

  • 400

    Bad Request - the body is not a JSON object, a field is empty or of the wrong type, map_type is not one of map_types, or profile_default_threshold is below 0 while server_mapview_limit is 0 or more.

  • 401

    Unauthorized - missing or invalid bearer token.

  • 403

    Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).

  • 409

    Conflict - Mapbox is not enabled on this server.

PUT /mapbox/settings
curl \
 --request PUT 'https://api.iformbuilder.com/exzact/api/v81/[servername]/mapbox/settings' \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer {access_token}" \
 --data '{
  "api_key": "sk.eyJ1IjoiemVyaW9uIiwiYSI6ImV4YW1wbGUifQ.Ab12",
  "user": "zerion",
  "map_type": "satellite-v9",
  "profile_default_threshold": 250
}'
Request example
{
  "api_key": "sk.eyJ1IjoiemVyaW9uIiwiYSI6ImV4YW1wbGUifQ.Ab12",
  "user": "zerion",
  "map_type": "satellite-v9",
  "profile_default_threshold": 250
}
Response examples (200)
{
  "enabled": true,
  "user": "zerion",
  "api_key_last4": "Ab12",
  "map_type": "satellite-v9",
  "map_types": [
    "streets-v11",
    "satellite-v9"
  ],
  "profile_default_threshold": 250,
  "server_mapview_limit": 2000
}