API and agentsAPI reference
Map
object
editRevisionstringpattern^[0-9a-f]{32}$Opaque durable revision paired with this document state. Camera and derived writes do not change it.
lastChangedAtstringor nullformatdate-timeTime of the last accepted covered change, independent of camera and cache clocks.
lastChangedByA named actor has display and fixed SQL names. { deleted: true } explicitly identifies a deleted actor and carries no names or profile fields. Null explicitly means unknown. Never inferred from ownership.
One of:
object
namestringrequiredsqlNamestringrequired
No other keys.
object
deletedbooleanalwaystruerequired
No other keys.
or null
idstringnamestringviewportViewportbasemapstringor nulldark | light | streets | satellite; null is Auto โ the builder follows the app theme (a deployment basemap override pins it), and published views render the deployment default.
customBasemapCustomBasemapThe map's custom basemap style; null = none. When set it wins over the key in every surface; the key survives underneath and returns when this clears.
basemapLayersBasemapLayersnoteMapNoteLegacy: always null โ the map's old note field migrated into a note widget. Kept for pre-migration undo images.
legendCornerLegendCornerlegendOrderLegendOrdertimelineMapTimelinewidgetsWidgetListwidgetsPublishedbooleanWhether widgets ship with the published view.
publishTokenstringor nullThe published link's token, the map owner's alone: null to anyone else who reaches the map, and null while unpublished. Handing the link out is publishing, which stays the owner's act.
publishedAtstringor nullpublishedbooleanWhether a publication is live, for everyone who reaches the map;
publishedAtsays since when.createdAtstringupdatedAtstring
All of:
object
editRevisionstringrequiredpattern^[0-9a-f]{32}$Opaque durable revision paired with this document state. Camera and derived writes do not change it.
lastChangedAtstringor nullrequiredformatdate-timeTime of the last accepted covered change, independent of camera and cache clocks.
lastChangedByrequiredA named actor has display and fixed SQL names. { deleted: true } explicitly identifies a deleted actor and carries no names or profile fields. Null explicitly means unknown. Never inferred from ownership.
One of:
object
namestringrequiredsqlNamestringrequired
No other keys.
object
deletedbooleanalwaystruerequired
No other keys.
or null
7439201b