Skip to main content
PATCH
Error

Authorizations

​
Authorization
string
header
required

Project-scoped API key. It cannot access account routes or create additional projects.

Headers

​
Bisibility-API-Version
enum<string>

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

Available options:
v1
​
X-Bisibility-Project
string

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.

Query Parameters

​
project
string

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.

Body

application/json
​
condition_type
enum<string>
required
Available options:
threshold,
change_pct,
ctr_drop,
position_drop,
downtrend,
enters_top_n,
exits_top_n,
competitor_overtake,
serp_feature,
url_mismatch
​
name
string
required
Required string length: 2 - 120
​
change_pct
number | null
Required range: 0.1 <= x <= 1000
​
channels
enum<string>[]

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.

Available options:
email,
slack,
webhook
​
competitor_domain
string | null
Required string length: 1 - 120
​
drop_positions
integer | null
Required range: 1 <= x <= 100
​
enabled
boolean
​
market_ids
string[]
Pattern: ^pmkt_[a-z][a-z0-9]{23}$
​
recipient_ids
string[]
Pattern: ^usr_[a-z][a-z0-9]{23}$
​
serp_feature
string | null
Required string length: 1 - 120
​
severity
enum<string>
Available options:
info,
warning,
urgent
​
target_ids
string[]
Pattern: ^kw_[a-z][a-z0-9]{23}$
​
target_type
enum<string>
Available options:
all,
keyword,
tag
​
threshold_position
integer | null
Required range: 1 <= x <= 100
​
top_n
integer | null
Required range: 1 <= x <= 100

Response

JSON response

The response is of type object.