Custom Search - Update Record API¶
Introduction¶
This API allows to update a record to the Custom search database. You can update the existing fields which suits your module.
URL¶
https://search.mappls.com/search/byod/update-record
HTTPS Method¶
PUT
Getting Access¶
Before using the API in the your solution, please ensure that the related access is enabled in the Mappls Console, within your app - be it for Mobile OR Web or Cloud integration.
- Copy and paste the key from your
credentialssection from your API keys into theaccess_tokenquery parameter.- Your static key can be secured by whitelisting its usage for particular IPs (in case of cloud app usage) OR a set of domains (in case of a web app)
- Your static key obtained from your Console is to be passed as a query parameter:
access_token.
Authentication Object - access_token mandatory query parameter.¶
access_token: "hklmgbwzrxncdyavtsuojqpiefrbhqplnm".
Response Type¶
application/json
Response Codes¶
Success¶
- 200: To denote a successful API call.
- 204: To denote the API was a success but no results we’re found.
Client-Side Issues¶
- 400: Bad Request, User made an error while creating a valid request.
- 401: Unauthorized, Developer’s key is not allowed to send a request.
- 403: Forbidden, Developer’s key has hit its daily/hourly limit.
Server-Side Issues¶
- 500: Internal Server Error, the request caused an error in our systems.
- 503: Service Unavailable, during our maintenance break or server downtimes.
Response Messages¶
- 200: Success.
- 204: No matches we’re found for the provided query.
- 400: Something’s just not right with the request.
- 401: Access Denied.
- 403: Forbidden, Services for this key has been suspended due to daily/hourly transactions limit.
- 500: Something went wrong.
- 503: Maintenance Break.
Request Parameters¶
The “bold” one’s are mandatory, and the “italic” one’s are optional.
Mandatory Parameters¶
recordId (string): Unique identifier of the record from the client.recordType (string): The category or class of the record referenced by a defined set of category.recordEloc (string): Eloc of the places.recordCoordinates (string): Latitude & Longitude of the record. E.g. "28.670023825198,77.22407913572087".
Note: Either recordEloc or recordCoordinates is required.
Optional Parameters¶
customNote (string): The custom note or description to the record.isExpired (boolean): Set to be true if record is expired; else set to false.extendedInfo (object): With this parameter client can add n number of information.
Sample cURL Request¶
curl --location --request PUT 'https://search.mappls.com/search/byod/update-record?access_token=hklmgbwzrxncdyavtsuojqpiefrbhqplnm' \
--header 'Content-Type: application/json' \
--data-raw '{
"recordId": "1002",
"recordType": "WFHORWFO",
"recordEloc": "06J7HP",
"customNote": "MapmyIndia Head Office",
"isExpired": false,
"extendedInfo":{
"pincode": "110044"
}
}'
Sample Response¶
{
"message": "UPDATED",
"responseCode": "200"
}
For any queries and support, please contact:
Email us at apisupport@mappls.com
Support
Need support? contact us!
@ Copyright 2025 CE Info Systems Ltd. All Rights Reserved.
Terms & Conditions | Privacy Policy | Supplier Sustainability Policy | Health & Safety Policy | Environmental Policy & CSR Report
Customer Care: +91-9999333223
