Skip to content

Custom Search - Delete Record API

Introduction

This API allows to delete a record permanently from the Custom search database. If the record or entity is obselete and no longer needs to be available for Nearby search, the API can delete the record permanently.

URL

https://search.mappls.com/search/byod

HTTPS Method

DELETE

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.

  1. Copy and paste the key from your credentials section from your API keys into the access_token query 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

  1. 200: To denote a successful API call.
  2. 204: To denote the API was a success but no results we’re found.

Client-Side Issues

  1. 400: Bad Request, User made an error while creating a valid request.
  2. 401: Unauthorized, Developer’s key is not allowed to send a request.
  3. 403: Forbidden, Developer’s key has hit its daily/hourly limit.

Server-Side Issues

  1. 500: Internal Server Error, the request caused an error in our systems.
  2. 503: Service Unavailable, during our maintenance break or server downtimes.

Response Messages

  1. 200: Success.
  2. 204: No matches we’re found for the provided query.
  3. 400: Something’s just not right with the request.
  4. 401: Access Denied.
  5. 403: Forbidden, Services for this key has been suspended due to daily/hourly transactions limit.
  6. 500: Something went wrong.
  7. 503: Maintenance Break.

Request Parameters

Mandatory Parameters

  1. recordId (string) : Unique identifier of the record from the client.

Sample cURL Request

curl --location --request DELETE 'https://search.mappls.com/search/byod?recordId=1002&access_token=hklmgbwzrxncdyavtsuojqpiefrbhqplnm'

Sample Response

{
    "message": "OK",
    "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.