Sign in
latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Holds

Delete a hold

Delete a hold. This action is irreversible. The hold will be permanently removed.

delete/v1/holds/{hold_id}

Path parameters

hold_idstring required

The unique identifier for the hold

Response

Successfully deleted the given hold

idstring

ID of the deleted hold

objectstring
deleted'true' | 'false'

Delete operation successful

Example response

{
  "id": "ho_123",
  "object": "hold",
  "deleted": "true"
}