Start a workflow run

posthttps://api.expiryedge.com/v1/createWorkflowRun
editor or admin60/minIdempotency-KeyJede Methode
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/createWorkflowRun' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "workflow_id": "wf_3Kd9Tx",
  "title": "License renewal - Dr. Lee",
  "assignees": [
    "u_71bXq",
    "u_93kLp"
  ]
}'
Antwort
{
  "message": "Workflow run created successfully",
  "run": {
    "id": "run_7Vb3",
    "workflow_id": "wf_3Kd9Tx",
    "workflow_title": "Annual license renewal",
    "title": "License renewal - Dr. Lee",
    "description": "Steps to renew a state dental license for Northwind Dental.",
    "status": "active",
    "progress": 0,
    "owner_id": "u_71bXq",
    "organization_id": "org_northwind",
    "workflow_type_id": "wtype_R4c2",
    "assignees": [
      "u_71bXq"
    ],
    "tags": [
      "licensing"
    ],
    "started_at": "2026-09-27T14:05:00.000Z",
    "created_at": "2026-09-27T14:05:00.000Z",
    "updated_at": "2026-09-27T14:05:00.000Z"
  }
}

Copies the workflow sections and steps into a new run. Step dates come from start_offset_days / due_offset_days relative to today when set. assignees (default: you) must be users of your organization; they get assignment notifications. Counts against the plan workflow_runs limit.

Header

  • Idempotency-Keystring
    Optional client-generated key (1-255 characters of letters, digits, - _ : .).
    pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body-Parameter

application/json
  • workflow_idstringerforderlich
  • titlestring
    Defaults to <workflow title> - <date>.
  • descriptionstring
    Defaults to the workflow description.
  • assigneesarray of string

Rückgabe

201
Run created.
  • messagestringerforderlich
  • runobjecterforderlich
    A run (instance) of a workflow template. owner_name, total_steps, completed_steps and progress are recomputed when listed.

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Your role does not allow this action, the record is in another organization, or the plan limit was reached (body is PlanLimitError).
404
The record does not exist or is not in your organization.
409
A request with the same Idempotency-Key is still being processed. Retry after Retry-After seconds.
422
The Idempotency-Key was already used with a different request body.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.