Skip to main content
PATCH
Update test set

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:
parameters
object

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

Example:
tags
string[] | null

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

Example:

Response

Test set updated successfully

test_set
object

Test set resource representation.