latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Delete a simulation persona

Delete a simulation persona. This endpoint only soft-deletes the simulation persona so any existing references to it would still be valid. However, they cannot be used in any new simulations.

This endpoint will error if the simulation persona is used in any simulation unit tests.

Permissions

This endpoint requires the following permissions:

  • Simulation:DeleteSimulationPersona on the simulation persona to delete.
delete/v1/{organization}/simulation/persona/{simulation_persona_id}/

Path parameters

organizationstring required
simulation_persona_idstring required

The ID of the simulation persona to delete.

The ID of the simulation persona to delete.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.