New Vendor Request Delete Tag
Syntax
DELETE new-vendor-requests/{nvr_id}/tags/{tag_id}
To delete a tag associated with a New Vendor Request identified by {nvr_id} you need to pass the {tag_id} in the URL. Don’t forget the trailing “/” after {tag_id}.
Example:
DELETE /api/new-vendor-requests/20100/tags/214/
Request Parameters
There are no request parameters for this API.
Success Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 204 | No Content | If the tag is found by its tag_id, it will be deleted and you will get the number of deleted tags (one) in the body of the response. |
Sample Response
A success response in Postman will look like this:
Error Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 400 | Bad Request | The request could not be understood by the server due to incorrect syntax. 20100 |
| 401 | Unauthenticated | The request requires user authentication information. Your API token is missing or invalid. |
| 403 | Forbidden | Unauthorized request. The client does not have access rights to the content. Unlike 401, the client’s identity is known to the server. |
| 404 | Not Found | Vendor {id} does not exist. |
| 500
503 | Service Unavailable | The request has failed due to a temporary failure of the server. You can try this request at a later time. |
An exception 404 where tag_id is not found for an existing nvr_id in Postman will look like this:
An exception 404 where nvr_id is not found in Postman will look like this:
Calling the API
Postman
Call Syntax:
{
"name": "NVR_DeleteTag",
"request": {
"auth": {
"type": "apikey",
"apikey": {
"value": "Token 500aXXXXXXXXXXXXXXXXXXXXXXXX6b1cf",
"key": "Authorization"
}
},
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": "https://sandbox.paymentworks.com/api/new-vendor-requests/19030/tags/248"
},
"response": []
},
Sample PostMan call:
cURL
Python
