---
title: "Modify settings for transaction check."
method: PUT
path: "/tms/check/{cid}"
tags: ["TMS Checks"]
---

# Modify settings for transaction check.

`PUT /tms/check/{cid}`

## Path parameters

- `cid` integer, required

## Request body

- CheckWithoutIDPUT — CheckWithoutIDPUT is a struct describing a TMS check data common for updating a check
  - `active` boolean — Check status: active or inactive
  - `contact_ids` integer[] — Contacts to alert
  - `custom_message` string — Custom message that is part of the email and webhook alerts
  - `interval` integer — TMS test intervals in minutes. Allowed intervals: 5,10,20,60,720,1440. The interval you're allowed to set may vary depending on your current plan.
  - `name` string — Name of the check
  - `region` string — Name of the region where the check is executed. Supported regions: us-east, us-west, eu, au
  - `send_notification_when_down` integer — Send notification when down X times
  - `severity_level` string — Check importance- how important are the alerts when the check fails. Allowed values: low, high
  - `steps` Step[] — steps to be executed as part of the check
    - `args` object — Parameters for the operation The actual parameters required depend on the chosen operation
      - `checkbox` string
      - `element` string
      - `form` string
      - `input` string
      - `option` string
      - `password` string
      - `radio` string
      - `seconds` string
      - `select` string
      - `url` string
      - `username` string
      - `value` string
    - `fn` string — Operation to be done
  - `team_ids` integer[] — Teams to alert
  - `metadata` Metadata — Recording related metadata. Used for recordings only. Modify with caution!
    - `width` integer, required — Width of the browser window
    - `height` integer, required — Height of the browser window
    - `disableWebSecurity` boolean, required — Setting this field to false will disable the same-origin policy during check execution
    - `authentications` object, required — Allowed values are either an empty JSON object (no authentication) or Basic Authentication
      - `httpAuthentications` HttpAuthentications[] — HTTP (browser-level) authentications. Currently, only Basic Authentication is supported
        - `credentials` object — Basic Authentication credentials to use on host
          - `password` string — Basic Authentication password
          - `userName` string — Basic Authentication Username
        - `host` string
  - `tags` string[] — List of tags for a check. The tag name may contain the characters 'A-Z', 'a-z', '0-9', '_' and '-'. The maximum length of a tag is 64 characters.
  - `integration_ids` integer[] — Integration identifiers as a list of integers.

## Response `200`

Detailed description of a modified check.

- CheckWithoutIDGET — CheckWithoutIDGET is a struct describing a TMS check data common for displaying a check
  - `active` boolean — Check status - active or inactive
  - `contact_ids` integer[] — Contacts to alert
  - `created_at` integer — Timestamp when the check was created
  - `modified_at` integer — Timestamp when the check was modified
  - `last_downtime_start` integer — Timestamp when the last downtime started. This field is optional
  - `last_downtime_end` integer — Timestamp when the last downtime ended. This field is optional
  - `custom_message` string — Custom message that is part of the email and webhook alerts
  - `interval` integer — TMS test intervals in minutes. Allowed intervals: 5,10,20,60,720,1440. The interval you're allowed to set may vary depending on your current plan.
  - `name` string — Name of the check
  - `region` string — Name of the region where the check is executed. Supported regions: us-east, us-west, eu, au
  - `send_notification_when_down` integer — Send notification when down X times
  - `severity_level` string — Check importance- how important are the alerts when the check fails. Allowed values: low, high
  - `status` string — Whether the check is passing or failing at the moment (successful, failing, unknown)
  - `steps` Step[] — steps to be executed as part of the check
    - `args` object — Parameters for the operation The actual parameters required depend on the chosen operation
      - `checkbox` string
      - `element` string
      - `form` string
      - `input` string
      - `option` string
      - `password` string
      - `radio` string
      - `seconds` string
      - `select` string
      - `url` string
      - `username` string
      - `value` string
    - `fn` string — Operation to be done
  - `team_ids` integer[] — Teams to alert
  - `integration_ids` integer[] — Integration identifiers.
  - `metadata` MetadataGET — Recording related metadata. Used for recordings only. Modify with caution!
    - `width` integer — Width of the browser window
    - `height` integer — Height of the browser window
    - `disableWebSecurity` boolean — Setting this field to false will disable the same-origin policy during check execution
    - `authentications` object — Allowed values are either an empty JSON object (no authentication) or Basic Authentication
      - `httpAuthentications` HttpAuthentications[] — HTTP (browser-level) authentications. Currently, only Basic Authentication is supported
        - `credentials` object — Basic Authentication credentials to use on host
          - `password` string — Basic Authentication password
          - `userName` string — Basic Authentication Username
        - `host` string
  - `tags` string[] — List of tags for a check. The tag name may contain the characters 'A-Z', 'a-z', '0-9', '_' and '-'. The maximum length of a tag is 64 characters.
  - `type` 'script' | 'recording' — Type of transaction check: "script" for regular TMS checks and "recording" for checks made using the Transaction Recorder

---

[API](https://skmtc.net/pingdom/apis/pingdom-public-api.md) · [All operations](https://skmtc.net/pingdom/apis/pingdom-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pingdom/pingdom-public-api/versions/d05c91a3c64b/schema)