Skip to main content
AI agents are now live in Website Scanner! Enter your URL and fix website issues 3x faster with AI. Explore now!
No Result Found
Get your setup working faster. Join our Discord for optimisation tips from elite testers. Join our DiscordJoin our Discord

Update cookie config API in Website Scanner

Use this API to update an existing cookie configuration. The API changes only the fields you send. To rotate cookies, send only the cookies field.

PUT /api/website-scanner/v1/cookie_configs/{id}

If Geo Region Restriction (GRR) is enabled for your account, add your region code to the host name: api-accessibility-<region>.browserstack.com. See Geo Region Restriction endpoints for the region codes and examples.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
     -X PUT "https://api-accessibility.browserstack.com/api/website-scanner/v1/cookie_configs/24" \
     -H "Content-Type: application/json" \
     -d '{ "cookies": "consent=accepted-v2; region=uk" }'
  • id* Integer

    The unique ID of the cookie configuration to update.

  • name String

    A unique name for the cookie configuration. Maximum 255 characters.

  • domain String

    The domain the cookies apply to, without a scheme or path (for example, example.com). The apex domain covers all subdomains, including www.

  • cookies String

    Semicolon-separated name=value pairs (for example, consent=accepted; region=uk). Maximum 50 cookies per configuration, cookie name up to 255 characters, cookie value up to 4096 characters.

Response attributes 200 OK JSON

Response

{
    "success": true,
    "data": {
        "id": 24,
        "name": "consent_config_1",
        "domain": "example.com",
        "cookies": "consent=accepted-v2; region=uk",
        "createdAt": "2026-10-09T10:00:00Z"
    },
    "error": null
}
  • success Boolean

    Indicates whether the request was successful.

  • data Object

    The updated cookie configuration object.

    â–¶ SHOW VALUES
    • id Integer

      The unique ID of the cookie configuration.

    • name String

      The name of the cookie configuration.

    • domain String

      The domain the cookies apply to.

    • cookies String

      Semicolon-separated name=value pairs representing the cookies.

    • createdAt String

      The ISO 8601 timestamp when the cookie configuration was created.

Error responses 404 Not Found

The API returns a 404 status code if the cookie configuration ID doesn’t exist or belongs to another account.

Error responses 422 Unprocessable Entity

The API returns a 422 status code when validation fails. The following validation errors can occur:

  • A cookie configuration named '<name>' already exists
  • '<domain>' is not a valid domain. Send the domain only, without https:// or a path
  • Cookie '<entry>' must be in name=value format
  • Duplicate cookie name '<name>'
  • Cookie name '<name>' is longer than 255 characters
  • Cookie '<name>' has a value longer than 4096 characters
  • A configuration can hold at most 50 cookies

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

Download Copy Check Circle