Sign in
latestOpenAPI 3.1.02026-08-19360412708.1 KB

4ef94eeb836d

Simulations

Set Simulation Always On

Set a simulation always-on and cascade the flag to all of its digital humans.

post/v1/simulations/{simulation_id}/always-on

Path parameters

simulation_idinteger required

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

always_onboolean required

when true, enable always-on for the simulation and all its digital humans; when false, disable

override_conflictboolean nullable

when true, deactivate always-on digital humans outside this simulation that share a phone number instead of returning 409

Response

Successful Response

simulation_idinteger required

ID of the simulation

always_onboolean required

resulting always-on state of the simulation

digital_humans_updatedinteger required

number of digital humans whose always-on flags were updated