> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a Test Suite

> Update test suite properties using JSON Patch

# Update a Test Suite

Update a test suite's properties using JSON Merge Patch. You can update by ID or by fully qualified name.

## Update by ID

<ParamField path="id" type="string" required>
  UUID of the test suite to update.
</ParamField>

## Update by Name

Use `PATCH /v1/dataQuality/testSuites/name/{fqn}` to update by fully qualified name.

<ParamField path="fqn" type="string" required>
  Fully qualified name of the test suite.
</ParamField>

## Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

<ParamField body="description" type="string">
  Updated description in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Updated display name.
</ParamField>

<ParamField body="owners" type="array">
  Updated list of owner references.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>
  </Expandable>
</ParamField>

<RequestExample dropdown>
  ```python PATCH /v1/dataQuality/testSuites/{id} theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import TestSuites

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # Retrieve, modify, and update
  ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
  ts.description = "Updated: Critical data quality checks for production tables"
  updated = TestSuites.update(ts)

  print(f"Updated to version {updated.version}")
  ```

  ```java PATCH /v1/dataQuality/testSuites/{id} theme={null}
  import static org.openmetadata.sdk.fluent.TestSuites.*;

  // Retrieve, modify, and update
  var ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572");
  ts.setDescription("Updated: Critical data quality checks for production tables");
  var updated = TestSuites.update(ts);
  ```

  ```bash PATCH /v1/dataQuality/testSuites/{id} theme={null}
  # Update by ID
  curl -X PATCH "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated: Critical data quality checks for production tables"}
    ]'

  # Update by name
  curl -X PATCH "{base_url}/api/v1/dataQuality/testSuites/name/b5fcae09-02c2-4c0b-8c4a-5b52d650e592" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated description"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
    "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "displayName": "Data Contract - dim_address_comprehensive_contract",
    "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "description": "Updated: Critical data quality checks for production tables",
    "version": 0.2,
    "updatedAt": 1769982800000,
    "updatedBy": "admin",
    "deleted": false,
    "owners": [],
    "executable": true
  }
  ```
</ResponseExample>

***

## Returns

Returns the updated test suite object with the new version number.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the test suite (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Test suite name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name of the test suite.
</ResponseField>

<ResponseField name="description" type="string">
  Updated description.
</ResponseField>

<ResponseField name="version" type="number">
  Incremented version number.
</ResponseField>

***

## Error Handling

| Code  | Error Type     | Description                                     |
| ----- | -------------- | ----------------------------------------------- |
| `400` | `BAD_REQUEST`  | Invalid JSON patch or malformed request         |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token         |
| `403` | `FORBIDDEN`    | User lacks permission to update this test suite |
| `404` | `NOT_FOUND`    | Test suite with given ID or FQN does not exist  |
| `409` | `CONFLICT`     | Concurrent modification detected                |