alerts

Change an alert rule's name, trigger, brands, cadence, channels or whether it is enabled; webhook_url null removes the webhook.

Change an alert rule's name, trigger, brands, cadence, channels or whether it is enabled; webhook_url null removes the webhook. Scope alerts:write; cache none.

patch/v1/workspaces/{ws}/alerts/{alertId}

Request

  • Base URL: https://api.storequant.com
  • URL: https://api.storequant.com/v1/workspaces/{ws}/alerts/{alertId}
  • Auth: HTTP bearer

Path parameters

wsstring required
alertIdstring uuid required

Request body

namestring
event_type'new_ads' | 'paused_ads' | 'page_change' | 'new_partner' | 'coverage'
brand_idsstring[]
cadence'daily' | 'weekly'
enabledboolean
emailboolean
webhook_urlstring uri nullable
webhook_kind'generic' | 'slack'

Response

Success.

Changes

No recorded changes to this operation across all 3 revisions of this API.