Swarms

Update a swarm

Changes the container's DEFAULTS. Journeys already authored under it keep the values they were created with — this is not a cascade.

patch/projects/{projectId}/swarms/{swarmId}

Request body

namestring
descriptionstring nullable
environmentIdsstring[] nullable
sessionsPerTargetinteger
maxTurnsinteger

Response

The updated swarm.

idstring required
projectIdstring required
namestring required
descriptionstring nullable required
environmentIdsstring[] required

Default fan-out for journeys authored under this container.

sessionsPerTargetinteger nullable required
maxTurnsinteger nullable required
setupWritesboolean

Whether prerequisite setup may create or modify workspace data before sessions run. Defaults to false.

createdAtnumber required

Epoch milliseconds.

updatedAtnumber required

Epoch milliseconds.

Changes