Start a run

Takes one person through an active automation now, whatever its trigger and even if they went through it before.

This does what the flow does: it sends real notifications.

Errors

Status	`type`	`code`	When
404	`not_found`	`person_not_found`	For a person the project does not have.
409	`conflict`	`automation_not_active`	For an automation that is not active.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Automations

This does what the flow does: it sends real notifications.

Guide: Automations

Errors

Status	`type`	`code`	When
404	`not_found`	`person_not_found`	For a person the project does not have.
409	`conflict`	`automation_not_active`	For an automation that is not active.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Automations

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

automationId*string

The automation's id, auto_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

personId*string

The person to enroll. Their reentry setting doesn't apply: they enter even if they went through before.

event?|

What the automation's steps read as the event that started the run.

inputs?|

Values for the variables the automation declares, by key; a key it doesn't declare is refused.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/automations/auto_p4n8c2v6x0z3q7w1e5r9t2y6/runs" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "personId": "person_h7d2k9m4x1c6v8b3n5q0w2e7"  }'

{  "id": "auto_run_b7m3x9c5v1q8w2e6r4t0y3u9",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "automationId": "auto_p4n8c2v6x0z3q7w1e5r9t2y6",  "versionId": "auto_ver_s2d6f0g4h8j1k5l9z3x7c1v5",  "personId": "person_h7d2k9m4x1c6v8b3n5q0w2e7",  "status": "queued",  "currentStepId": null,  "waitingForEvent": null,  "nextAt": null,  "lastError": null,  "event": null,  "variables": {},  "createdAt": "2026-03-14T09:30:00.000Z",  "finishedAt": null}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"personId\"]"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "person_not_found",    "message": "This project has no person person_h7d2k9m4x1c6v8b3n5q0w2e7.",    "param": "personId"  }}

{  "error": {    "type": "conflict",    "code": "automation_not_active",    "message": "Only an active automation can be paused."  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Errors

More in Automations

Start a run

Errors

More in Automations

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Start a run

Start a run

person_not_found

project_not_found

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`