See api-docs Menu

Delete Mapping

Use this API to delete a User Mapping.

Resource URL


Header Parameters




Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Resource Parameter




Set to the id of the mapping that you want to update. If you do not know the id, use the List Mappings API call to return all mappings and their id values.

Sample Responses

Success. The mapping is deleted. No content is returned.

Typically, this error means that your access token value is invalid.

    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"

A mapping with that ID does not exist.

    "name": "NotFoundError",
    "message": "Resource not found",
    "statusCode": 404

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Run in Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Sample Code


Replace sample values indicated by < > with your actual values.

Delete a Mapping

curl 'https://<subdomain>/api/2/mappings/:id' \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.