Skip to main content

Update Channel Health Thresholds

PUT 
/api/channel-health/thresholds

Bulk upserts warn thresholds and returns the full effective list. Statuses and alerts are re-evaluated straight away.

Required scope: channel-health:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body: thresholds (array, 1–200 items), each with:

  • metric (string, required): metric key
  • channel (string, required): amazon or walmart
  • integration_instance_id (integer, optional): null for the tenant default, an instance ID for an override
  • warn_value (number, optional): null restores the default warn level
  • clear_margin (number, optional, 0–100, default 0.5)
  • min_denominator (integer, optional, 0–1000000, default 10)
  • small_sample_warning (boolean, optional, default true)
  • enabled (boolean, optional, default true)

Returns 422 when a warn level is on or past the marketplace target (a warn level can only be stricter than the target) or when the metric isn't monitored on the channel; errors are keyed thresholds.<index>.<field>.

Authentication: Bearer token (Personal Access Token) with the channel-health:write scope. The user needs the Alert Preferences › Update permission.

Request​

Responses​

OK

Response Headers
    Content-Type