TriggersService

Modify Trigger

Modify a trigger by trigger ID using a limited patch for trigger pricing and trailing/slippage parameters.

Method

PUT

Path

/v1/triggers/{trigger_id}

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

PUT

/v1/triggers/{trigger_id}

Request

Testnet

curl --request PUT \ \
  --url 'https://api.testnet.polyester.com/v1/triggers/9155001234567' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE' \
  --header 'Content-Type: application/json' \
  --data '{
  "activationPrice": "0.005",
  "limitPrice": "0.005",
  "maxSlippageTicks": 0,
  "subaccountId": "45LUmqjT",
  "symbol": "BTC-USDT",
  "trailingDistanceTicks": "0.000000001",
  "triggerId": "59VD7Lar",
  "triggerPrice": "0.005"
}'

Responses

{
  "status": "CREATED",
  "triggerId": "59VD7Lar",
  "tsNs": "1735689600000000000"
}

trigger_id string required > 0

Trigger ID (base58 public ID)

activationPrice string /^[0-9]…9]+)?$/

Updated activation price in quote units scaled by 1e9. Set to zero to clear an existing activation price; omit to leave it unchanged.

limitPrice string /^[0-9]…9]+)?$/

Updated limit price in quote units scaled by 1e9 for LIMIT child orders.

maxSlippageBps integer (int32)

Updated maximum allowed slippage in basis points (1 bp = 0.01%). Set to zero to clear the cap.

maxSlippageTicks integer (int64)

Non-negative maximum absolute price delta in Q9 execution-price ticks (1 tick = 1e-9 quote units). Set to zero to clear the cap.

subaccountId string /^[1-9A…m-z]+$/

Optional sub-account for authorization.

symbol string required

Trading pair symbol, e.g. BTC-USDT.

trailingDistanceBps integer (int32) required

Updated trailing distance in basis points (1 bp = 0.01%).

trailingDistanceTicks string /^[0-9]…9]+)?$/

Updated trailing distance as a price delta in 1e-9 quote-unit ticks.

triggerId string required /^[1-9A…m-z]+$/

Trigger ID to modify.

triggerPrice string /^[0-9]…9]+)?$/

Patch fields for safe price, trailing-distance, and slippage edits. For stop/take-profit: Updated trigger price in quote units scaled by 1e9.

status enum

Current trigger status after modification.

CREATED ARMED RUNNING COMPLETED CANCELED FAILED PAUSED

Example CREATED

triggerId string /^[1-9A…m-z]+$/

Modified trigger ID.

Example 59VD7Lar

tsNs string /^[0-9]+$/

Server timestamp in nanoseconds since epoch (UTC).

Example 1735689600000000000

Possible errors: 5

Key	Status	Error	When
unauthenticated	401	Unauthenticated	Authentication required.
permission-denied	403	Permission Denied	Permission denied.
invalid-argument	400	Invalid Argument	Invalid argument.
not-found	404	Not Found	Not found.
unavailable	503	Unavailable	Service unavailable.

Polyester is best experienced on desktop.

Request

Responses