projects

Update project defaults

Changed on

Preview first, then confirm the exact source/revision/token with a stable command key. Lost responses replay the same committed receipt. Omitted review refuses before writes; changed source or expired quotes require a new preview. Existing targets/history are not retargeted.

patch/projects/{project_id}/defaults

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/defaults
  • 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

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000

Query parameters

preview_onlyboolean

Requires capabilities.features.reviewed_project_defaults=v1. true reads the current signed draft without writes or provider calls. Confirm that exact draft with review on a later PATCH.

Headers

Bisibility-API-Version'v1'

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

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

citystring nullable

Optional city name resolved within country when location_key is omitted. Deprecated legacy market input: send location_key instead. Still accepted for compatibility; no removal version is scheduled.

country'United States' | 'United Kingdom' | 'Canada' | 'Australia' | 'Germany' | 'France' | 'Spain' | 'Italy' | 'Netherlands' | 'Sweden' | 'Poland' | 'Ireland' | 'Portugal' | 'Belgium' | 'Switzerland' | 'Austria' | 'Denmark' | 'Norway' | 'Finland' | 'Brazil' | 'Mexico' | 'India' | 'Japan' | 'Singapore' | 'New Zealand' | 'South Africa' | 'United Arab Emirates'

Optional country selector when location_key is omitted. Provide together with device. Deprecated legacy market input: send location_key instead. Still accepted for compatibility; no removal version is scheduled.

cron_expressionstring nullable
device'desktop' | 'mobile'

Optional device selector. Provide with country when location_key is omitted; with location_key it overrides the current default device.

frequency'paused' | 'manual' | 'daily' | 'weekly' | 'monthly' | 'custom_cron'
jitter_minutesinteger

Whole-minute random delay from 0 to 120. Set 0 to disable jitter.

location_keystring

Primary location reference: canonical country, region, or city key, optionally qualified with @language. Updates the default market from a canonical location key. Country and city are resolved from the location catalog; device defaults to the current default device when omitted.

serp_depth10 | 20 | 50 | 100

Default number of SERP results scanned per rank check. Omitted keeps the stored depth.

serp_stop_on_matchboolean

Set false to fetch the full configured depth for competitor snapshots.

timezonestring

IANA time zone that anchors monthly and custom cron wall-clock schedules. Daily and weekly use a stable keyword-specific interval phase that timezone does not move.

Example request

{
  "country": "United States",
  "location_key": "ES/Andalusia/Malaga@en"
}

Response

JSON response

OR

Example response

{
  "country": "United States",
  "location_key": "ES/Andalusia/Malaga@en",
  "project_id": "prj_a00000000000000000000000"
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • breaking

      removed the media type application/json for the response with the status

    • info

      the endpoint scheme security AppOAuth was added to the API

    • 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

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status