See api-docs Menu

Delete Mapping

Use this API to delete a User Mapping.










Resource URL

https://<api-domain>/api/2/mappings/:id

Header Parameters

Authorization

required

string

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: Read All, or Manage All.

Resource Parameter

id

required

integer

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.

Download for User Mappings API

Sample Code

cURL

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

Delete a Mapping

curl 'https://<api-domain>/api/2/mappings/:id' \
-X DELETE \
-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.