Edit a browser test

Edit the configuration of a Synthetic browser test.

public_idstring required

The public ID of the test to edit.

Request body

locationsstring[] required

Array of locations used to run the test.

messagestring required

Notification message associated with the test. Message can either be text or an empty string.

monitor_idinteger

The associated monitor ID.

namestring required

Name of the test.

public_idstring

The public ID of the test.

status'live' | 'paused'

Define whether you want to start (live) or pause (paused) a Synthetic test.

tagsstring[]

Array of tags attached to the test.

type'browser' required

Type of the Synthetic test, browser.

Example request

{
  "config": {
    "assertions": [],
    "configVariables": [
      {
        "name": "VARIABLE_NAME",
        "type": "text"
      }
    ],
    "request": {
      "basicAuth": {
        "password": "PaSSw0RD!",
        "type": "web",
        "username": "my_username"
      },
      "bodyType": "text/plain",
      "callType": "unary",
      "mcpProtocolVersion": "2025-06-18",
      "proxy": {
        "url": "https://example.com"
      },
      "service": "Greeter",
      "toolName": "search",
      "url": "https://example.com"
    },
    "variables": [
      {
        "name": "VARIABLE_NAME",
        "type": "text"
      }
    ]
  },
  "locations": [
    "aws:eu-west-3"
  ],
  "name": "Example test name",
  "options": {
    "ci": {
      "executionRule": "blocking"
    },
    "device_ids": [
      "chrome.laptop_large"
    ],
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ],
    "rumSettings": {
      "applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "clientTokenId": 12345,
      "isEnabled": true
    },
    "scheduling": {
      "timeframes": [
        {
          "day": 1,
          "from": "07:00",
          "to": "16:00"
        },
        {
          "day": 3,
          "from": "07:00",
          "to": "16:00"
        }
      ],
      "timezone": "America/New_York"
    }
  },
  "status": "live",
  "steps": [
    {
      "type": "assertElementContent"
    }
  ],
  "tags": [
    "env:prod"
  ],
  "type": "browser"
}

Response

OK