Cancel Local Hold Request

PUT /api/.../holds/{id}?action=cancel&activePending=[true|false]

Cancel a local hold request for a patron.

Request Information

Name Type Required Description
id Integer Yes ID of local hold request
activePending Boolean No Set to 'true' will limit cancelling of hold requests to only those with Active or Pending status.
patronId Integer No Check if patron with patronId is an owner of hold request. Returns 404 if provided patron is not an owner.

Response Information

An HTTP return status code of 200 indicates success.

Example
application/json, text/json 
1000

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.

Required Permissions

Permission IDs found here.

    HoldRequests_Modify (based on the pickup branch ID)