Create Simulation

Create a simulation engagement for testing agent flows with mock data.

post/admin/simulations/

Request

Base URL
https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or HTTP bearer

organization-idstring nullable

timezonestring

x-user-idstring nullable

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

organization_idstring required

agent_idstring required

contact_idstring nullable

campaign_idstring nullable

targeting_rulesobject[] nullable

synthetic_leadboolean

lead_intakestring nullable

lead_sourcestring

lead_namestring nullable

modelstring nullable

variablesobject nullable

runner_versionstring nullable

include_engagement_historyboolean

variant_idstring nullable

openerstring nullable

contact_method_idstring nullable

Successful Response

engagement_idstring required

organization_idstring required

agent_v2_idstring nullable

statusstring required

is_simulatedboolean required

No recorded changes to this operation across all 1 revision of this API.