Sign in
Swarms

Update a journey

Editing a goal never disturbs a run already under way: a run pins its own immutable snapshot of the definition at launch.

patch/projects/{projectId}/goals/{goalId}

Request body

namestring
goalstring
environmentIdsstring[] nullable

A non-empty list to set, or null to clear and fall back to host targets.

serverAttachmentIdstring nullable

null clears the attachment.

hostIdsstring[]
iterationsinteger
maxTurnsinteger

Response

The updated goal.

idstring required
projectIdstring required
namestring required
goalstring required

What the persona is trying to accomplish. This drives the whole run.

personaIdstring required
swarmIdstring nullable required

The swarm container this goal was authored under. Provenance only — nothing resolves through it at run time, and a goal created outside a swarm has none.

environmentIdsstring[] required

Environments this goal fans out across. EMPTY on a host-pinned goal — that is a different execution model, not a goal with no targets.

serverAttachmentIdstring

Legacy host-pinned grounding. Absent on an environment-based goal.

iterationsinteger nullable required

Sessions run against EACH target. Total sessions = targets × this.

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

Changed in 1 of the 122 revisions of this API.1