Maps

Update Map Endpoint

Update a map's metadata and/or replace its layers.

put/maps/{map_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

map_idstring uuid required

Request body

namestring nullable
descriptionstring nullable
notesstring nullable
center_lngnumber nullable

Map center longitude

center_latnumber nullable

Map center latitude

zoomnumber nullable

Map zoom level

bearingnumber nullable

Map rotation in degrees

pitchnumber nullable

Map tilt in degrees (0-85)

basemap_stylestring nullable

Basemap style ID or URL

show_basemap_labelsboolean nullable
visibility'private' | 'internal' | 'public'
pluginsstring[] nullable

Enabled plugin IDs, e.g. ['measurement']

legend_titlestring nullable

Custom map-level legend title. Null or empty leaves the legend without a heading override. At most 120 characters.

Response

Successful Response

idstring uuid required
namestring required
descriptionstring nullable required
notesstring nullable
center_lngnumber nullable required
center_latnumber nullable required
zoomnumber nullable required
bearingnumber required
pitchnumber required
basemap_stylestring required
show_basemap_labelsboolean required
visibility'private' | 'internal' | 'public' required
thumbnail_urlstring nullable
og_image_urlstring nullable
forked_from_idstring uuid nullable

Source map UUID if this is a fork

forked_from_namestring nullable
created_bystring uuid nullable required
created_by_usernamestring nullable
created_atstring date-time required
updated_atstring date-time required
layer_countinteger required
pluginsstring[] nullable
legend_titlestring nullable

Changes

No recorded changes to this operation across all 50 revisions of this API.