triggers.v1.TriggersService

ModifyTrigger

Modify a trigger (limited patch).

Method

POST

Path

triggers.v1.TriggersService/ModifyTrigger

Service

triggers.v1.TriggersService

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

POST

triggers.v1.TriggersService/ModifyTrigger

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/triggers.v1.TriggersService/ModifyTrigger' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "activationPriceTicks": "61000250000000",
  "limitPriceTicks": "61000250000000",
  "maxSlippageTicks": "0",
  "subaccountId": "6789012345678",
  "symbolId": 1,
  "trailingDistanceTicks": "1",
  "triggerId": "9155001234567",
  "triggerPriceTicks": "61000250000000"
}'

Responses

{
  "status": "STATUS_CREATED",
  "triggerId": "9155001234567",
  "ts": "2025-01-01T00:00:00Z",
  "tsNs": "1735689600000000000"
}

Request

triggers.v1.ModifyTriggerRequest

Response

triggers.v1.ModifyTriggerResponse

triggerId string (fixed64) > 0

Trigger ID to modify.

subaccountId string (fixed64)

Optional public subaccount ID for authorization. When omitted, subaccount-scoped API keys use their bound subaccount; other callers use their authenticated root account.

symbolId integer (int32)

Optional trading symbol numeric identifier. Zero or omitted means the trigger's own pair. When set, it must be the trigger's pair: another listed pair is rejected with ERROR_CODE_TRIGGER_SYMBOL_MISMATCH, and a pair that is not listed with ERROR_CODE_UNKNOWN_SYMBOL; either leaves the trigger unchanged. An API key limited to specific markets must name the trigger's pair.

triggerPriceTicks string (int64) > 0

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

limitPriceTicks string (int64)

Not modifiable: a trigger's child limit price is fixed at create. Setting this field rejects the whole request with ERROR_CODE_TRIGGER_CHILD_PRICE_NOT_MODIFIABLE (InvalidArgument, HTTP 400) and leaves the trigger unchanged; cancel the trigger and create a new one to change the child limit price.

trailingDistanceTicks string (int64) > 0

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

trailingDistanceBps integer (int32) 1–10000

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

one-of

activationPriceTicks string (int64) ≥ 0

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

maxSlippageTicks string (int64) ≥ 0

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

maxSlippageBps integer (int32) 0–10000

Updated maximum allowed slippage in basis points (1 bp = 0.01%). Set to zero to clear the cap. A buy stop-loss or take-profit with a market child accepts 1 to 10000, as at creation. A trailing stop on either side, and a sell stop-loss or take-profit, accept 1 to 9999: 10000 is rejected with ERROR_CODE_MAX_SLIPPAGE_INVALID, because a 100% cap would leave a sell no positive price, and a trailing stop takes none on either side.

one-of

triggerId string (fixed64)

Modified trigger ID.

status enum

Current trigger status after modification.

STATUS_CREATED STATUS_ARMED STATUS_RUNNING STATUS_COMPLETED STATUS_CANCELED STATUS_FAILED STATUS_PAUSED

ts string (date-time)

Server timestamp.

tsNs string (uint64)

Server timestamp in nanoseconds since epoch (UTC).

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.