Skip to main content
PATCH
/
test-sets
/
{test_set_id}
Update test set
curl --request PATCH \
  --url https://api.coval.dev/v1/test-sets/{test_set_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "display_name": "Updated Test Set Name",
  "slug": "updated-slug",
  "description": "Updated description",
  "test_set_type": "WORKFLOW",
  "test_set_metadata": {
    "category": "support",
    "updated": true
  },
  "parameters": {
    "name": [
      "Alice",
      "Bob"
    ]
  },
  "tags": [
    "regression"
  ]
}
'
{
  "test_set": {
    "name": "test-sets/abc12345",
    "id": "abc12345",
    "slug": "customer-support-scenarios",
    "display_name": "Customer Support Scenarios",
    "description": "Test cases for customer support agent",
    "test_set_type": "SCENARIO",
    "test_set_metadata": {
      "category": "support",
      "priority": "high"
    },
    "parameters": {
      "customer_name": [
        "Alice",
        "Bob"
      ],
      "issue_type": [
        "billing",
        "technical"
      ]
    },
    "test_case_count": 42,
    "tags": [
      "regression",
      "voice"
    ],
    "create_time": "2025-10-14T12:00:00Z",
    "update_time": "2025-10-15T14:30:00Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Organization API key for authentication

Path Parameters

​
test_set_id
string
required

Test set ID (8-character ID)

Required string length: 8

Body

application/json

Update request. Only provided fields will be updated.

​
display_name
string

Human-readable test set name

Required string length: 1 - 100
Example:

"Updated Test Set Name"

​
slug
string

URL-friendly identifier

Maximum string length: 100
Example:

"updated-slug"

​
description
string | null

Test set description

Example:

"Updated description"

​
test_set_type
string

Test set type

Maximum string length: 50
Example:

"WORKFLOW"

​
test_set_metadata
object

Additional configuration (null = don't update, {} = clear field)

Example:
{ "category": "support", "updated": true }
​
parameters
object

Test case parameterization (null = don't update, {} = clear field)

Example:
{ "name": ["Alice", "Bob"] }
​
tags
string[] | null

Tags to associate with this test set. Null or omitted leaves tags unchanged. Pass [] to clear all tags.

Example:
["regression"]

Response

Test set updated successfully

​
test_set
object

Test set resource representation.