keywords

Bulk mutate keywords

Changed on
post/keywords/bulk

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/keywords/bulk
  • 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)

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

frequency'paused' | 'manual' | 'daily' | 'weekly' | 'monthly' | 'custom_cron'
keyword_idsstring[] required
operation'add_tags' | 'delete' | 'remove_tags' | 'set_frequency' | 'set_target_url' required
tagsstring[]
target_urlstring nullable

Response

JSON response

operation'add_tags' | 'delete' | 'remove_tags' | 'set_frequency' | 'set_target_url' required

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added required request body

    • 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

      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

      added the required property to the response with the status

    • info

      added the required property to the response with the status