Update OTC Order Rule by ID

Update an existing OTC order rule by its ID.

Request

PUT /v2/admin/otc-order-rules/{id}

Parameters

Name	Type	In	Description
id	string	path	The ID of the rule to update

Request Body

Name	Type	Required	Description
side	integer	No	Offer side to match. See Side enum below
rule_type	integer	No	Rule evaluation type. See RuleType enum below
match_action	integer	No	Action to take when rule matches. See MatchAction enum below
consume_on_match	boolean	No	If true, consume the rule after a match
status	integer	No	Activation status. See RuleStatus enum below
priority	integer	No	Priority value; lower can be treated as higher precedence
name	string	No	Rule name
token_id	string	No	Target token ID (optional)
above_percent	number	No	Accept if offer is up to +X% above reference price (RuleType=Percent)
below_percent	number	No	Accept if offer is down to -X% below reference price (RuleType=Percent)
above_amount	number	No	Accept if unit price is at most reference + amount (RuleType=Absolute)
below_amount	number	No	Accept if unit price is at least reference - amount (RuleType=Absolute)
min_offer_quantity	integer	No	Minimum acceptable offer quantity
max_offer_quantity	integer	No	Maximum acceptable offer quantity
valid_from	string (ISO 8601)	No	Start timestamp for rule validity
valid_until	string (ISO 8601)	No	End timestamp for rule validity

Enums

RuleType	Value	Meaning
Unconditional	1	Auto-accept any incoming OTC offer
Percent	2	Accept if offer within percent thresholds of reference price
Absolute	3	Accept if unit price within absolute min/max thresholds

RuleStatus	Value	Meaning
Inactive	1	Rule disabled
Active	2	Rule enabled

Side	Value	Meaning
Both	1	Match both buy and sell offers
Buy	2	Match buy-side offers
Sell	3	Match sell-side offers

MatchAction	Value	Meaning
Accept	1	Accept the matched offer
Reject	2	Reject the matched offer

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer token for authentication

Example

curl --location --request PUT '\{\{baseUrl\}\}/v2/admin/otc-order-rules/6910a6ab5f635dd4dc251581' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--data '{
  "side": 1,
  "rule_type": 2,
  "consume_on_match": true,
  "status": 2,
  "priority": 3,
  "name": "Example Rule",
  "token_id": "6909ddb65b25a8f90960506a",
  "above_percent": 11,
  "below_percent": 23,
  "min_offer_quantity": 1,
  "max_offer_quantity": 4
}'

Response

{
  "id": "6910a6ab5f635dd4dc251581",
  "node_id": "6901350deb7ed8c1c38de4e9",
  "token_id": "6909ddb65b25a8f90960506a",
  "side": 1,
  "rule_type": 2,
  "match_action": 1,
  "above_percent": 11,
  "below_percent": 23,
  "min_offer_quantity": 1,
  "max_offer_quantity": 4,
  "consume_on_match": true,
  "priority": 3,
  "status": 2,
  "valid_from": "2025-11-12T01:04:12Z",
  "valid_until": "2025-11-19T01:04:24Z",
  "name": "Example Rule",
  "created_by": "665b372f3a72d7d0791596ba",
  "created_at": "2025-11-09T14:35:23.19Z",
  "updated_at": "2025-11-10T12:04:47.951493+03:00",
  "is_api": false
}

Response Fields

Field	Type	Description
id	string	Unique identifier of the rule
node_id	string	Node ID
token_id	string	Token ID (if provided)
side	integer	Side value (see enum)
rule_type	integer	Rule type (see enum)
match_action	integer	Match action (see enum)
above_percent	number	Upper percent threshold (if set)
below_percent	number	Lower percent threshold (if set)
min_offer_quantity	integer	Minimum quantity (if set)
max_offer_quantity	integer	Maximum quantity (if set)
consume_on_match	boolean	Whether the rule is consumed on match
priority	integer	Priority value
status	integer	Status (see enum)
valid_from	string	ISO 8601 start of validity (if set)
valid_until	string	ISO 8601 end of validity (if set)
name	string	Rule name
created_by	string	Creator ID
created_at	string	ISO 8601 timestamp when created
updated_at	string	ISO 8601 timestamp when updated
is_api	boolean	Whether created by API

Status Codes

Code	Description
200	OK
400	Bad Request - Validation error
401	Unauthorized - Missing or invalid token
404	Not Found - Rule ID does not exist
500	Internal Server Error