Skip to main content
PUT
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

groupId
string<uuid>
required

The simulation group ID

Body

application/json

Omitted fields keep their current value. Run groups the group already started keep theirs.

name
string
Required string length: 1 - 200
description
string | null

Send null to clear it.

Maximum string length: 2000
simulationRunPlanIds
string<uuid>[]

Replaces the plans, in run order.

Required array length: 2 - 20 elements
notifications
object

Replaces the notification settings as a whole.

Example:

Response

The updated group

data
object
required

A saved, repeatable set of plans that run together. Each run starts one run of every plan and groups them into a run group with one combined report.