Skip to main content
POST
Place stocks on hold

Request Structure

Key Fields

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json

Request body for placing stocks on hold

ids
integer[]
required

Array of stock IDs to place on hold

description
string
required

Reason for placing stock on hold

reason_code_id
integer | null

Reason code ID for audit trail

Response

Stocks placed on hold successfully

Standard successful response wrapper following JSON:API format

data
object

The response payload