Skip to navigation
API ReferenceAlerts and API keys

Create Rule

View as Markdown

Authentication

X-API-Keystring

Your Outprice API key (starts with pw_).

Query parameters

require_deliverableboolean or nullOptional

Refuse the rule (409) unless an alert from it could be delivered right now. On by default for API keys, off for the dashboard. Send false to create rules before confirming where they go.

Request

This endpoint expects an object.
threshold_typeenumRequired
tracked_item_idinteger or nullOptional
category_tagstring or nullOptional
threshold_valuedouble or nullOptional
channelenum or nullOptional
frequency_capenumOptional

FR-3.4 — configurable per channel, so immediate WhatsApp can coexist with a daily email digest.

Allowed values:

Response

Successful Response
idinteger
threshold_typeenum
channelenum
frequency_capenum

FR-3.4 — configurable per channel, so immediate WhatsApp can coexist with a daily email digest.

Allowed values:
activeboolean
tracked_item_idinteger or nullOptional
category_tagstring or nullOptional
threshold_valuedouble or nullOptional
deliverablebooleanOptionalDefaults to true
delivery_problemstring or nullOptional

Errors

422
Unprocessable Entity Error