SendKuy API
API Reference

Trigger a workflow

Answers with a report — how many workflows were triggered and how many contacts were enrolled — not with the workflow. One call can start more than one workflow, because the trigger matches on conditions.

Try it — POST /workflows/{id}/trigger

Kept for this tab only — it disappears when you close it, and it is never sent anywhere except as the Authorization header on the call below.

Authorization

bearerAuth automation:write
AuthorizationBearer <token>

Authorization: Bearer sk_live_.... Keys in the query string or the request body are refused — a URL is logged by every proxy it passes, and that is how customer keys leak.

A key carries scopes. A call outside them answers 403 with insufficient_scope and names the scope it wanted.

In: header

Scope: automation:write

Path Parameters

id*string

The prefixed id of the object.

Header Parameters

Idempotency-Key?string

Any unique string, one per logical request. Retrying with the same key returns the first answer instead of doing the work twice, and answers with Idempotent-Replay: true.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST https://app.sendkuy.com/api/v1/workflows/wfl_9cBe3A1H-SLhW5fONWZ32wb-IIio5Ts3/trigger \  -H "Authorization: Bearer sk_live_YOUR_API_KEY"
{  "data": {    "object": "workflow_trigger",    "id": "string",    "workflows_triggered": 0,    "contacts_enrolled": 0,    "errors": [      null    ]  }}