triggers.v1.TriggersService

PauseTrigger

Pause a trigger (sets status=PAUSED).

Method

POST

Path

triggers.v1.TriggersService/PauseTrigger

Service

triggers.v1.TriggersService

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

POST

triggers.v1.TriggersService/PauseTrigger

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/triggers.v1.TriggersService/PauseTrigger' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "subaccountId": "6789012345678",
  "triggerId": "9155001234567"
}'

Responses

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

Request

triggers.v1.PauseTriggerRequest

Response

triggers.v1.PauseTriggerResponse

triggerId string (fixed64) > 0

Trigger ID to pause.

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.

triggerId string (fixed64)

Paused trigger ID.

status enum

Current trigger status after pausing.

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.