Create Custom Hold

Required permission: write_orders

Creates a custom-hold definition. Organization API keys may set client_id; omitting it creates an organization-wide hold. Client API keys create a hold for their own client and may omit client_id. Custom holds must be enabled for the organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer | null
≥ 1

Owning client ID. Organization keys may omit this to create an organization-wide hold.

string
required
length between 1 and 255
boolean
Defaults to false

Whether this hold prevents allocation when assigned to an order.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json