Simulate Automation

POST /v1/automations/{automationId}/simulate

Dry-run simulation showing the path a contact would take. No side effects.

Path parameters

automationIdstringrequired

Automation ID to simulate

Bodyrequired

contactIdstring

Existing contact ID to simulate with

contactobject

Inline contact data for simulation

seedinteger

Random seed for deterministic simulation

Min: -9007199254740991Max: 9007199254740991

Response

200Simulation completed successfully. Returns the simulated path.

objectstringrequired

automationIdstringrequired

ID of the simulated automation

automationNamestringrequired

Name of the simulated automation

contactIdstringrequired

ID of the contact used in simulation

contactEmailstringrequired

Email of the contact used in simulation

status"completed" | "error"required

Simulation outcome status

totalStepsnumberrequired

Total number of steps in the simulated path

stepsobject[]required

curl -X POST "https://api.kibamail.com/v1/automations/{automationId}/simulate" \ -H "Authorization: Bearer kb_your_api_key" \ -H "Content-Type: application/json" \ -d '{ "contactId": "string", "contact": { "email": "string", "firstName": "string", "lastName": "string", "phone": "string", "country": "string", "timezone": "string", "city": "string", "status": "SUBSCRIBED", "properties": {}, "topics": [ "string" ] }, "seed": -9007199254740991 }'

{ "object": "string", "automationId": "string", "automationName": "string", "contactId": "string", "contactEmail": "string", "status": "completed", "totalSteps": 1, "steps": [ { "step": 1, "nodeId": "string", "nodeType": "string", "nodeName": "string", "action": "string", "detail": "string", "branch": "string" } ] }

Overview

Contacts

Topics

Segments

Forms

API Keys

Automations

Broadcasts

Contact Properties

Events

Inbox

Marketing Emails

Sending Domains

Transactional Emails

Simulate Automation

Path parameters

Bodyrequired

Response