v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Simulations

Update scenario

Update an existing scenario with new configuration.

patch/simulations/{simulationReference}

Path parameters

simulationReferencestring required

Reference ID of the scenario

Query parameters

projectIdstring required

Project identifier

Request body

namestring

Name of the scenario

personastring

Persona description

personaNamestring

Name of the persona

missionstring

Mission description

maxTurnsinteger

Maximum number of turns

timeoutinteger

Timeout in seconds

aiAgentReferenceIdstring

Reference ID of the AI Agent

flowReferenceIdstring

Reference ID of the Flow

jobNodeIdstring

Job Node ID

Response

Scenario updated successfully

idstring required

Unique identifier for the scenario

referenceIdstring required

Reference ID for the scenario

namestring required

Name of the scenario

personastring required

Persona description

personaNamestring required

Name of the persona

missionstring required

Mission description

maxTurnsinteger

Maximum number of turns

timeoutinteger

Timeout in seconds

aiAgentReferenceIdstring

Reference ID of the AI Agent

aiAgentIdstring

Database ID of the AI Agent

flowReferenceIdstring

Reference ID of the Flow

flowIdstring

Database ID of the Flow

jobNodeIdstring

Job Node ID

organisationReferencestring required

Organization reference

projectReferencestring required

Project reference

createdAtinteger required

Creation timestamp

createdBystring required

User who created the scenario

updatedAtinteger

Last update timestamp

updatedBystring

User who last updated the scenario

lastChangedinteger required

Last change timestamp

lastChangedBystring required

User who made the last change