---
title: "Update test metadata"
method: PATCH
path: "/test/{id}/metadata"
tags: ["Test"]
---

# Update test metadata

`PATCH /test/{id}/metadata`

Update the unversioned metadata of an existing test

## Path parameters

- `id` string, required

## Query parameters

- `field_mask` string[]

## Headers

- `If-Match` string

## Request body

- TestMetadata
  - `id` string — Unique identifier
  - `created_by_id` string — The ID of the user who created this test
  - `last_updated_time` integer — Time the test was last updated in epoch milliseconds
  - `last_updated_by_id` string — The ID of the user who last updated this test
  - `created_time` integer — Time the test was created in epoch milliseconds
  - `revision_history` string — Serialized graph describing the test's version history. Managed by mabl API only.
  - `version_tags` object — Mapping of version tags to version numbers that the tag is currently applied to
  - `latest_version` integer — The latest numeric version of this test
  - `organization_id` string — (deprecated) The ID of the organization that this journey belongs to
  - `workspace_id` string — Workspace Id
  - `enabled` boolean — If test is enabled to execute
  - `name` string — The display name of the test
  - `description` string — Brief description the test
  - `device_emulation` DeviceEmulation — Emulation configuration
    - `device_config` DeviceEmulationConfiguration, required — Emulation configuration
      - `name` string, required — Emulation configuration display name
      - `preset_type` 'blackberry_playbook' | 'blackberry_z30' | 'galaxy_fold' | 'galaxy_note_3' | 'galaxy_note_ii' | 'galaxy_s5' | 'galaxy_s6' | 'galaxy_s8' | 'galaxy_s21' | 'galaxy_s22' | 'galaxy_s23' | 'galaxy_s_iii' | 'galaxy_tab_s7' | 'ipad' | 'ipad_air_2020' | 'ipad_mini' | 'ipad_mini_4' | 'ipad_pro' | 'ipad_ten_point_two' | 'iphone_11_pro_max' | 'iphone_11' | 'iphone_12' | 'iphone_12_pro_max' | 'iphone_13_mini' | 'iphone_13' | 'iphone_13_pro' | 'iphone_13_pro_max' | 'iphone_14' | 'iphone_14_pro' | 'iphone_14_plus' | 'iphone_14_pro_max' | 'iphone_15' | 'iphone_15_plus' | 'iphone_15_pro' | 'iphone_15_pro_max' | 'iphone_4' | 'iphone_5_se' | 'iphone_6_7_8' | 'iphone_6_7_8_plus' | 'iphone_x' | 'jiophone_2' | 'kindle_fire_hdx' | 'laptop_with_hidpi_screen' | 'laptop_with_mdpi_screen' | 'laptop_with_touch' | 'lg_optimus_l70' | 'microsoft_lumia_550' | 'microsoft_lumia_950' | 'moto_g4' | 'nexus_4' | 'nexus_5' | 'nexus_5x' | 'nexus_6' | 'nexus_6p' | 'nexus_7' | 'nexus_10' | 'nokia_lumia_520' | 'nokia_n9' | 'pixel_2' | 'pixel_2_xl' | 'pixel_6' | 'surface_duo' — Preset device configuration (optional)
      - `user_agent` string — Client User Agent string
      - `type` 'phone' | 'tablet' | 'notebook' — General device type
      - `capabilities` string[] — Optional device capabilities
      - `screen` object — Screen configuration
        - `device_pixel_ratio` number, double — Device pixel ratio (may be decimal)
        - `horizontal` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
        - `vertical` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
    - `orientation` 'portrait_primary' | 'portrait_secondary' | 'landscape_primary' | 'landscape_secondary', required — Fixed device orientation
  - `device_emulations` DeviceEmulation[] — List of browser device emulation configurations. Empty list means configured for desktop
    - `device_config` DeviceEmulationConfiguration, required — Emulation configuration
      - `name` string, required — Emulation configuration display name
      - `preset_type` 'blackberry_playbook' | 'blackberry_z30' | 'galaxy_fold' | 'galaxy_note_3' | 'galaxy_note_ii' | 'galaxy_s5' | 'galaxy_s6' | 'galaxy_s8' | 'galaxy_s21' | 'galaxy_s22' | 'galaxy_s23' | 'galaxy_s_iii' | 'galaxy_tab_s7' | 'ipad' | 'ipad_air_2020' | 'ipad_mini' | 'ipad_mini_4' | 'ipad_pro' | 'ipad_ten_point_two' | 'iphone_11_pro_max' | 'iphone_11' | 'iphone_12' | 'iphone_12_pro_max' | 'iphone_13_mini' | 'iphone_13' | 'iphone_13_pro' | 'iphone_13_pro_max' | 'iphone_14' | 'iphone_14_pro' | 'iphone_14_plus' | 'iphone_14_pro_max' | 'iphone_15' | 'iphone_15_plus' | 'iphone_15_pro' | 'iphone_15_pro_max' | 'iphone_4' | 'iphone_5_se' | 'iphone_6_7_8' | 'iphone_6_7_8_plus' | 'iphone_x' | 'jiophone_2' | 'kindle_fire_hdx' | 'laptop_with_hidpi_screen' | 'laptop_with_mdpi_screen' | 'laptop_with_touch' | 'lg_optimus_l70' | 'microsoft_lumia_550' | 'microsoft_lumia_950' | 'moto_g4' | 'nexus_4' | 'nexus_5' | 'nexus_5x' | 'nexus_6' | 'nexus_6p' | 'nexus_7' | 'nexus_10' | 'nokia_lumia_520' | 'nokia_n9' | 'pixel_2' | 'pixel_2_xl' | 'pixel_6' | 'surface_duo' — Preset device configuration (optional)
      - `user_agent` string — Client User Agent string
      - `type` 'phone' | 'tablet' | 'notebook' — General device type
      - `capabilities` string[] — Optional device capabilities
      - `screen` object — Screen configuration
        - `device_pixel_ratio` number, double — Device pixel ratio (may be decimal)
        - `horizontal` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
        - `vertical` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
    - `orientation` 'portrait_primary' | 'portrait_secondary' | 'landscape_primary' | 'landscape_secondary', required — Fixed device orientation
  - `tags` Tag[] — Tag objects associated with this test
    - `name` string, required — tag name
    - `values` string[]
  - `default` boolean — Whether this test is a default test generated for all customers from a template
  - `labels` Label[] — User provided labels
    - `name` string, required — name
    - `color` string — color
  - `datatables` string[] — Array of datatable IDs for datatables that satisfy the parameter requirements of the test
  - `export_variables` boolean — Whether this test should export variables
  - `source_control_tags` object — (deprecated, use versionTags) mapping of source control tags to version numbers the tag is currently applied to
  - `ref_id` string — Reference id to this test in another system
  - `test_type` 'api' | 'browser' | 'performance' | 'mobile' — Type of test
  - `test_source` 'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent' — Where the test lives
  - `test_cases` ExternalTestCase[] — User provided external test cases (limit 20)
    - `id` string — Id associated with this test case
  - `send_mabl_header` boolean — Controls whether or not the x-mabl-agent header is sent on requests
  - `execution_runner_size` 'x1' | 'x2' | 'x3' | 'x4' | 'x5' | 'x6' | 'small' | 'medium' | 'large' | 'inherit' — available runner sizes
  - `mobile_platform` 'android' | 'ios' — The mobile platform associated with this object
  - `intent` string — The intent of the test as natural language
  - `test_case_id` string — Unique identifier of the associated TestCase

## Response `200`

The updated test on the master branch

- TestMetadata
  - `id` string — Unique identifier
  - `created_by_id` string — The ID of the user who created this test
  - `last_updated_time` integer — Time the test was last updated in epoch milliseconds
  - `last_updated_by_id` string — The ID of the user who last updated this test
  - `created_time` integer — Time the test was created in epoch milliseconds
  - `revision_history` string — Serialized graph describing the test's version history. Managed by mabl API only.
  - `version_tags` object — Mapping of version tags to version numbers that the tag is currently applied to
  - `latest_version` integer — The latest numeric version of this test
  - `organization_id` string — (deprecated) The ID of the organization that this journey belongs to
  - `workspace_id` string — Workspace Id
  - `enabled` boolean — If test is enabled to execute
  - `name` string — The display name of the test
  - `description` string — Brief description the test
  - `device_emulation` DeviceEmulation — Emulation configuration
    - `device_config` DeviceEmulationConfiguration, required — Emulation configuration
      - `name` string, required — Emulation configuration display name
      - `preset_type` 'blackberry_playbook' | 'blackberry_z30' | 'galaxy_fold' | 'galaxy_note_3' | 'galaxy_note_ii' | 'galaxy_s5' | 'galaxy_s6' | 'galaxy_s8' | 'galaxy_s21' | 'galaxy_s22' | 'galaxy_s23' | 'galaxy_s_iii' | 'galaxy_tab_s7' | 'ipad' | 'ipad_air_2020' | 'ipad_mini' | 'ipad_mini_4' | 'ipad_pro' | 'ipad_ten_point_two' | 'iphone_11_pro_max' | 'iphone_11' | 'iphone_12' | 'iphone_12_pro_max' | 'iphone_13_mini' | 'iphone_13' | 'iphone_13_pro' | 'iphone_13_pro_max' | 'iphone_14' | 'iphone_14_pro' | 'iphone_14_plus' | 'iphone_14_pro_max' | 'iphone_15' | 'iphone_15_plus' | 'iphone_15_pro' | 'iphone_15_pro_max' | 'iphone_4' | 'iphone_5_se' | 'iphone_6_7_8' | 'iphone_6_7_8_plus' | 'iphone_x' | 'jiophone_2' | 'kindle_fire_hdx' | 'laptop_with_hidpi_screen' | 'laptop_with_mdpi_screen' | 'laptop_with_touch' | 'lg_optimus_l70' | 'microsoft_lumia_550' | 'microsoft_lumia_950' | 'moto_g4' | 'nexus_4' | 'nexus_5' | 'nexus_5x' | 'nexus_6' | 'nexus_6p' | 'nexus_7' | 'nexus_10' | 'nokia_lumia_520' | 'nokia_n9' | 'pixel_2' | 'pixel_2_xl' | 'pixel_6' | 'surface_duo' — Preset device configuration (optional)
      - `user_agent` string — Client User Agent string
      - `type` 'phone' | 'tablet' | 'notebook' — General device type
      - `capabilities` string[] — Optional device capabilities
      - `screen` object — Screen configuration
        - `device_pixel_ratio` number, double — Device pixel ratio (may be decimal)
        - `horizontal` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
        - `vertical` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
    - `orientation` 'portrait_primary' | 'portrait_secondary' | 'landscape_primary' | 'landscape_secondary', required — Fixed device orientation
  - `device_emulations` DeviceEmulation[] — List of browser device emulation configurations. Empty list means configured for desktop
    - `device_config` DeviceEmulationConfiguration, required — Emulation configuration
      - `name` string, required — Emulation configuration display name
      - `preset_type` 'blackberry_playbook' | 'blackberry_z30' | 'galaxy_fold' | 'galaxy_note_3' | 'galaxy_note_ii' | 'galaxy_s5' | 'galaxy_s6' | 'galaxy_s8' | 'galaxy_s21' | 'galaxy_s22' | 'galaxy_s23' | 'galaxy_s_iii' | 'galaxy_tab_s7' | 'ipad' | 'ipad_air_2020' | 'ipad_mini' | 'ipad_mini_4' | 'ipad_pro' | 'ipad_ten_point_two' | 'iphone_11_pro_max' | 'iphone_11' | 'iphone_12' | 'iphone_12_pro_max' | 'iphone_13_mini' | 'iphone_13' | 'iphone_13_pro' | 'iphone_13_pro_max' | 'iphone_14' | 'iphone_14_pro' | 'iphone_14_plus' | 'iphone_14_pro_max' | 'iphone_15' | 'iphone_15_plus' | 'iphone_15_pro' | 'iphone_15_pro_max' | 'iphone_4' | 'iphone_5_se' | 'iphone_6_7_8' | 'iphone_6_7_8_plus' | 'iphone_x' | 'jiophone_2' | 'kindle_fire_hdx' | 'laptop_with_hidpi_screen' | 'laptop_with_mdpi_screen' | 'laptop_with_touch' | 'lg_optimus_l70' | 'microsoft_lumia_550' | 'microsoft_lumia_950' | 'moto_g4' | 'nexus_4' | 'nexus_5' | 'nexus_5x' | 'nexus_6' | 'nexus_6p' | 'nexus_7' | 'nexus_10' | 'nokia_lumia_520' | 'nokia_n9' | 'pixel_2' | 'pixel_2_xl' | 'pixel_6' | 'surface_duo' — Preset device configuration (optional)
      - `user_agent` string — Client User Agent string
      - `type` 'phone' | 'tablet' | 'notebook' — General device type
      - `capabilities` string[] — Optional device capabilities
      - `screen` object — Screen configuration
        - `device_pixel_ratio` number, double — Device pixel ratio (may be decimal)
        - `horizontal` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
        - `vertical` DeviceScreenDimensions
          - `height` integer, required — Height (pixels)
          - `width` integer, required — Width (pixels)
    - `orientation` 'portrait_primary' | 'portrait_secondary' | 'landscape_primary' | 'landscape_secondary', required — Fixed device orientation
  - `tags` Tag[] — Tag objects associated with this test
    - `name` string, required — tag name
    - `values` string[]
  - `default` boolean — Whether this test is a default test generated for all customers from a template
  - `labels` Label[] — User provided labels
    - `name` string, required — name
    - `color` string — color
  - `datatables` string[] — Array of datatable IDs for datatables that satisfy the parameter requirements of the test
  - `export_variables` boolean — Whether this test should export variables
  - `source_control_tags` object — (deprecated, use versionTags) mapping of source control tags to version numbers the tag is currently applied to
  - `ref_id` string — Reference id to this test in another system
  - `test_type` 'api' | 'browser' | 'performance' | 'mobile' — Type of test
  - `test_source` 'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent' — Where the test lives
  - `test_cases` ExternalTestCase[] — User provided external test cases (limit 20)
    - `id` string — Id associated with this test case
  - `send_mabl_header` boolean — Controls whether or not the x-mabl-agent header is sent on requests
  - `execution_runner_size` 'x1' | 'x2' | 'x3' | 'x4' | 'x5' | 'x6' | 'small' | 'medium' | 'large' | 'inherit' — available runner sizes
  - `mobile_platform` 'android' | 'ios' — The mobile platform associated with this object
  - `intent` string — The intent of the test as natural language
  - `test_case_id` string — Unique identifier of the associated TestCase

## Other responses

- `401` — User not authenticated
- `403` — User not authorized
- `404` — Test not found
- `default` — Unknown error

---

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