alerts

Update an alert rule

Changed on Oct 19, 2026

patch/alert-rules/{rule_id}

Request

Base URL: https://eu.bisibility.com/api/v1
URL: https://eu.bisibility.com/api/v1/alert-rules/{rule_id}
Auth: one of:
- HTTP bearer
- HTTP bearer
- OAuth 2 (authorization code, authorization URL /api/auth/oauth2/authorize, token URL /api/auth/oauth2/token, scopes: api:write)

Path parameters

rule_idstring required

Example:alr_a00000000000000000000000

Query parameters

projectstring

Query-parameter equivalent of the X-Bisibility-Project header for personal-access-token project selection. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project.

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

Idempotency-Keystring

Optional key that makes a retry of this request return the first response instead of running it again. Replays last 24 hours and are scoped to the credential, method and path.

X-Bisibility-Projectstring

Project public ID (prj_...) targeted by this personal-access-token request. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project. Project API keys and paths that already carry a project ID ignore it.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Request body

channelsstring[]

Delivery channels for alert notifications. Slack tenant delivery is available as an API-only preview. Workspace installation and channel management are not yet exposed in the dashboard. Push sends to the iOS devices that project members registered through /me/push-tokens; alerts from scheduled checks arrive as one summary push per rule. Every fired alert also creates an in-app notification, with or without channels.

change_pctnumber nullable

competitor_domainstring nullable

drop_positionsinteger nullable

enabledboolean

namestring required

market_idsstring[]

recipient_idsstring[]

serp_featurestring nullable

severity'info' | 'warning' | 'urgent'

target_type'all' | 'keyword' | 'tag'

threshold_positioninteger nullable

top_ninteger nullable

Response

JSON response

Example response

{
  "target_ids": [
    "kw_a00000000000000000000000"
  ],
  "id": "alr_a00000000000000000000000"
}

Changes

Oct 19, 2026a6e1ec0dec82 Revision changes
- breaking
  added the new path request parameter rule_id
- breaking
  request body became required
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  removed subschema #1 subschema #2 from the / request property oneOf list
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  the / request property's maxLength was set to 120
- warning
  the / request property's maxLength was set to 120
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the endpoint scheme security AppOAuth was added to the API
- info
  added the new optional header request parameter Idempotency-Key
- info
  the request property default value was added
- info
  the request property default value true was added
- info
  the request property default value was added
- info
  the request property default value all was added
- info
  added the new push enum value to the request property /
- info
  added subschema #1 subschema #2 to the / request property oneOf list
- info
  added subschema #1 subschema #2 subschema #3 subschema #4 to the response body anyOf list for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status

Operation history