search
Sign upHelp Center

commentComments

APIs for programatic collaboration

Comments bring conversations to mapping.

With these APIs, you can export, resolve, and delete map comments and collaboration threads.

hashtag
Export map comments

get

Export all comments and replies from a map in CSV, JSON, or GeoJSON format.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
map_idstringRequired

The ID of the map to export comments from.

Query parameters
formatstringOptional

The format to export the comments in: 'csv', 'json' (default), or 'geojson'

Responses
chevron-right
200

Comment export response

application/json
get
/api/v2/maps/{map_id}/comments/export

hashtag
Resolve map comment

post

Mark a comment thread as resolved.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
map_idstringRequired

The ID of the map that contains the comment.

comment_idstringRequired

The ID of the comment to resolve.

Responses
chevron-right
200

Comment resolved response

application/json
post
/api/v2/maps/{map_id}/comments/{comment_id}/resolve

hashtag
Delete map comment

delete

Permanently delete a comment or reply from the map.

circle-exclamation

This action cannot be undone. The comment or reply will be permanently removed from the map.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
map_idstringRequired

The ID of the map that contains the comment.

comment_idstringRequired

The ID of the comment to delete.

Responses
delete
/api/v2/maps/{map_id}/comments/{comment_id}
No content
PreviousUsersNextEmbed Tokens

Last updated

Was this helpful?