Skip to main content
PATCH
Update a test group

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).

Path Parameters

groupId
string<uuid>
required

Test group ID

Body

application/json
name
string
Required string length: 1 - 255
runMode
enum<string>
Available options:
concurrent,
sequential
maxConcurrentRuns
integer | null

Pass null to follow the plan limit again.

Required range: x >= 1
prepTestId
string<uuid> | null

Web test that runs first and saves its browser session. Any web test in the project qualifies; it does not have to be a member of this group. Pass null to clear.

Response

Group updated

group
object
required