TriggersService

Pause Trigger

Pause a trigger by trigger ID without deleting it. Supported for stop-loss, take-profit and trailing-stop triggers; ladder and TWAP triggers support only cancel and answer TRIGGER_NOT_MODIFIABLE.

Method

POST

Path

/v1/triggers/{trigger_id}/pause

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

POST

/v1/triggers/{trigger_id}/pause

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/v1/triggers/59VD7Lar/pause' \
  --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 '{
  "triggerId": "59VD7Lar"
}'

Responses

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

trigger_id string required > 0

Trigger ID (base58 public ID)

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

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

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

Trigger ID to pause.

status enum

Current trigger status after pausing.

CREATED ARMED RUNNING COMPLETED CANCELED FAILED PAUSED

Example PAUSED

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

Paused trigger ID.

Example 59VD7Lar

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

Server timestamp in nanoseconds since epoch (UTC).

Example 1735689600000000000

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.