v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB

Places_Multi-Geocode

Update Place

The "Update Place" method allows businesses to update the attributes of an existing place.

This method allows you to update the attributes of custom places. In effect, updating a place replaces the current information in search results with the updated information associated with the specific docID. Use this method to enhance the accuracy/usability of your search results with respect to the default dataset to suit your business needs.

If you want to prioritize a particular result in your search results, update the ‘score’ of that specific place.
Alternatively, you can block places which are no longer needed by setting their status: ‘disable’.

put/multigeocode/place/{docId}

Path parameters

docIdstring required

Unique NextBillion ID of the location to be updated.

Query parameters

keystring 32 character alphanumeric string required

Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

scoreinteger

Search score of the place. This is calculated based on how ‘richly’ the place is defined. For instance, a place with street name, city, state and country attributes set might be ranked lower than a place which has values of house, building, street name, city, state and country attributes set. The score determines the rank of the place among search results. You can also use this field to set a custom score as per its relevance to rank it among the search results from multiple data sources.

Response

statusstring

Represents the status of the response.

msgstring

This could be “Ok” representing success or “not found” representing error in processing the request.