Skip to main content
PUT
Update hold reason

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

reason_id

Body

application/json
label
string

Human-readable label, ≤ 255 characters. Mutable on both system and user reasons.

Example:

"QC Follow-up (revised)"

display_group
string | null

Display group name, ≤ 25 characters. Mutable on both system and user reasons.

Example:

"Hold"

allow_relocation
boolean | null

Whether inventory under this hold may be relocated. User reasons: true / false / null (null = inherit from parent). System reasons: true or false only — null is rejected (422) because system reasons have no parent to inherit from.

Example:

false

is_active
boolean

Whether this reason is active. Mutable on both system and user reasons.

Example:

true

sort_order
integer

Display order within siblings. Mutable on both system and user reasons.

Example:

10

merchants
MerchantRef · object[] | null

Merchant scope restrictions. Empty array or null = unrestricted. User reasons: mutable. System reasons: rejected (422) — system reasons are not merchant-scoped.

Response

Hold reason updated.