Automations

Workflows (trigger → conditions → actions, delays, waits, goals), versions, dry runs, run logs and recipes.

GET/v1/workflows

Workflows

Newest first; archived workflows only when asked for with `status=archived`.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

statusquery: WorkflowStatus
qquery: string
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of WorkflowListItem
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/workflows' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "description": "string",
      "status": "draft",
      "active_version": 0,
      "trigger": {
        "event": "string",
        "label": "string"
      },
      "recipe": {
        "key": "string",
        "version": 0
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "runs_7d": 0,
      "failed_7d": 0,
      "success_rate_7d": 0,
      "last_run_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows

Create a workflow (draft)

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

namerequired: string
description: string or null
graph: WorkflowGraphInput
Default: a lone "Lead created" trigger.
settings: WorkflowSettingsInput

Response · 201

datarequired: Workflow
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","graph":{"format":1,"nodes":[{"id":"string","type":"string","label":"string","notes":"string","position":{"x":0,"y":0},"config":{}}],"edges":[{"id":"string","source":"string","target":"string","handle":"string","label":"string"}]},"settings":{"reentry":{"mode":"once","days":1},"allow_concurrent_runs":true,"max_runs_per_entity_per_day":1,"respect_quiet_hours":true,"alert_member_ids":["cmusrceel0000q7kaafxqi1om"]}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/catalogue

Builder catalogue

Triggers with their fields and operators, actions with parameter schemas and availability, AI steps.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Response · 200

datarequired: WorkflowCatalogue
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/catalogue' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "triggers": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "category": "string",
        "entity": "string",
        "entity_label": "string",
        "supports_changes": true,
        "producer_task": "string",
        "fields": [
          {
            "key": "string",
            "label": "string",
            "type": "string",
            "of": "string",
            "options": [
              null
            ],
            "ops": [
              null
            ]
          }
        ]
      }
    ],
    "actions": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "category": "string",
        "message": true,
        "needs_lead": true,
        "entities": [
          "string"
        ],
        "available": true,
        "available_with": "string",
        "params_schema": {}
      }
    ],
    "ai_nodes": [
      {
        "type": "string",
        "label": "string",
        "description": "string",
        "output": "string",
        "available": true,
        "available_with": "string",
        "config_schema": {}
      }
    ],
    "delay_modes": [
      "string"
    ],
    "limits": {
      "max_nodes": 0,
      "max_edges": 0,
      "max_wait_days": 0,
      "max_delay_days": 0
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/options

Builder pickers

Members, roles, pipeline statuses (by key), lead sources and message templates for the builder.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Response · 200

datarequired: WorkflowBuilderOptions
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/options' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "role_key": "string",
        "role_name": "string"
      }
    ],
    "roles": [
      {
        "key": "string",
        "name": "string"
      }
    ],
    "statuses": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_name": "string",
        "sub_statuses": [
          {
            "key": "string",
            "name": "string"
          }
        ]
      }
    ],
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string"
      }
    ],
    "templates": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "channel": "string",
        "name": "string",
        "display_name": "string",
        "purpose": "string",
        "status": "string",
        "language": "string"
      }
    ],
    "sequences": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "status": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/recipes

Recipe gallery

Ready-made workflows (docs §6.5) with what this company still lacks for each.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Response · 200

datarequired: array of WorkflowRecipe
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/recipes' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "key": "string",
      "number": 0,
      "version": 0,
      "name": "string",
      "description": "string",
      "category": "string",
      "templates": [
        {
          "channel": "string",
          "purpose": "string",
          "label": "string"
        }
      ],
      "options_schema": {},
      "summary": [
        "string"
      ],
      "missing": [
        {
          "kind": "channel",
          "key": "string",
          "message": "string"
        }
      ],
      "installed": 0
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/recipes/{key}/install

Install a recipe

Creates the workflow — live when nothing is missing, otherwise a draft listing what to set up first.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

keypathrequired: string
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body (optional)

overrides: map of any

Response · 201

datarequired: WorkflowRecipeInstall
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/recipes/{key}/install' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response example

{
  "data": {
    "workflow": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "description": "string",
      "status": "draft",
      "active_version": 0,
      "trigger": {
        "event": "string",
        "label": "string"
      },
      "recipe": {
        "key": "string",
        "version": 0
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "graph": {
        "format": 1,
        "nodes": [
          {
            "id": "string",
            "type": "string",
            "label": "string",
            "notes": "string",
            "position": {
              "x": null,
              "y": null
            },
            "config": {}
          }
        ],
        "edges": [
          {
            "id": "string",
            "source": "string",
            "target": "string",
            "handle": "string",
            "label": "string"
          }
        ]
      },
      "settings": {
        "reentry": {
          "mode": "once",
          "days": 1
        },
        "allow_concurrent_runs": true,
        "max_runs_per_entity_per_day": 0,
        "respect_quiet_hours": true,
        "alert_member_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "recipe": {
          "key": "string",
          "version": 0
        }
      },
      "published_at": "2026-10-06T05:30:00.000Z",
      "has_unpublished_changes": true,
      "issues": [
        {
          "code": "string",
          "severity": "error",
          "message": "string",
          "path": [
            "string"
          ],
          "node_id": "string",
          "edge_id": "string"
        }
      ],
      "summary": [
        "string"
      ]
    },
    "activated": true,
    "missing": [
      {
        "kind": "channel",
        "key": "string",
        "message": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/validate

Validate an unsaved graph

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Request body

graphrequired: any
A WorkflowGraph (checked by the engine).

Response · 200

datarequired: WorkflowValidation
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/validate' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"graph":null}'

Response example

{
  "data": {
    "valid": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/{id}

A workflow

The draft graph with its issues and summary, settings and the live version.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Workflow
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/workflows/{id}

Save the draft

Name, description and graph change the draft only (publish makes it live); settings apply at once.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
description: string or null
graph: WorkflowGraphInput
settings: WorkflowSettingsInput

Response · 200

datarequired: Workflow
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/workflows/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","graph":{"format":1,"nodes":[{"id":"string","type":"string","label":"string","notes":"string","position":{"x":0,"y":0},"config":{}}],"edges":[{"id":"string","source":"string","target":"string","handle":"string","label":"string"}]},"settings":{"reentry":{"mode":"once","days":1},"allow_concurrent_runs":true,"max_runs_per_entity_per_day":1,"respect_quiet_hours":true,"alert_member_ids":["cmusrceel0000q7kaafxqi1om"]}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/workflows/{id}

Archive a workflow

Stops it and cancels its active runs; the run history stays.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Workflow
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/workflows/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/{id}/dry-run

Test with a record

Walks the draft (or a version) for a sample record of the trigger’s kind without side effects: conditions are evaluated, actions show what they would do, delays and waits advance a simulated clock.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

entity_idrequired: Id
A record of the trigger’s kind (a lead for lead triggers …).
payload: map of any
The sample event payload.
version: integer
A published version instead of the draft.
waits: map of "event" | "timeout"
ai: map of string

Response · 200

datarequired: WorkflowDryRun
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/{id}/dry-run' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity_id":"cmusrceel0000q7kaafxqi1om","payload":{},"version":0,"waits":{},"ai":{}}'

Response example

{
  "data": {
    "would_start": true,
    "reason": "string",
    "steps": [
      {
        "node_id": "string",
        "node_type": "string",
        "label": "string",
        "status": "string",
        "at": "2026-10-06T05:30:00.000Z",
        "input": null,
        "output": null,
        "error": "string"
      }
    ],
    "outcome": "completed",
    "error": "string",
    "started_at": "2026-10-06T05:30:00.000Z",
    "ended_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/{id}/pause

Pause a workflow

No new runs; running runs wait at their next step until the workflow is resumed.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Workflow
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/{id}/pause' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/{id}/publish

Publish the draft

Validates and freezes the draft as a new version; new runs use it, running runs keep theirs.

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body (optional)

activate: boolean

Response · 200

datarequired: Workflow
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/{id}/publish' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/{id}/resume

Resume a workflow

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Workflow
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/{id}/resume' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "active_version": 0,
    "trigger": {
      "event": "string",
      "label": "string"
    },
    "recipe": {
      "key": "string",
      "version": 0
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "graph": {
      "format": 1,
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "notes": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "handle": "string",
          "label": "string"
        }
      ]
    },
    "settings": {
      "reentry": {
        "mode": "once",
        "days": 1
      },
      "allow_concurrent_runs": true,
      "max_runs_per_entity_per_day": 0,
      "respect_quiet_hours": true,
      "alert_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "recipe": {
        "key": "string",
        "version": 0
      }
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "has_unpublished_changes": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/{id}/runs

Runs of a workflow

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

idpathrequired: Id
Opaque record id.
statusquery: WorkflowRunStatus
entity_typequery: string
entity_idquery: Id
Opaque record id.
fromquery: string (date-time)
Runs started at or after this instant (ISO 8601).
toquery: string (date-time)
Runs started before this instant (ISO 8601).
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of WorkflowRun
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/{id}/runs' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "version": 0,
      "entity_type": "string",
      "entity_id": "string",
      "lead_id": "string",
      "status": "running",
      "current_node": "string",
      "wake_at": "2026-10-06T05:30:00.000Z",
      "waiting_for": "string",
      "error": "string",
      "outcome": "string",
      "trigger_event": {
        "id": "string",
        "type": "string"
      },
      "started_at": "2026-10-06T05:30:00.000Z",
      "finished_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/{id}/runs/{runId}

A run with its steps

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

idpathrequired: Id
Opaque record id.
runIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: WorkflowRunDetail
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/{id}/runs/{runId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "version": 0,
    "entity_type": "string",
    "entity_id": "string",
    "lead_id": "string",
    "status": "running",
    "current_node": "string",
    "wake_at": "2026-10-06T05:30:00.000Z",
    "waiting_for": "string",
    "error": "string",
    "outcome": "string",
    "trigger_event": {
      "id": "string",
      "type": "string"
    },
    "started_at": "2026-10-06T05:30:00.000Z",
    "finished_at": "2026-10-06T05:30:00.000Z",
    "chain": [
      "string"
    ],
    "steps": [
      {
        "id": "string",
        "node_id": "string",
        "node_type": "string",
        "status": "done",
        "input": null,
        "output": null,
        "error": "string",
        "started_at": "2026-10-06T05:30:00.000Z",
        "finished_at": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/{id}/stats

Runs per day

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

idpathrequired: Id
Opaque record id.
daysquery: integer

Response · 200

datarequired: WorkflowStats
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/{id}/stats' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "from": "2026-10-06T05:30:00.000Z",
    "to": "2026-10-06T05:30:00.000Z",
    "days": [
      {
        "date": "string",
        "started": 0,
        "completed": 0,
        "failed": 0,
        "cancelled": 0,
        "active": 0
      }
    ],
    "totals": {
      "started": 0,
      "completed": 0,
      "failed": 0,
      "cancelled": 0,
      "active": 0
    },
    "success_rate": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/workflows/{id}/validate

Validate the draft

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: WorkflowValidation
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/workflows/{id}/validate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "valid": true,
    "issues": [
      {
        "code": "string",
        "severity": "error",
        "message": "string",
        "path": [
          "string"
        ],
        "node_id": "string",
        "edge_id": "string"
      }
    ],
    "summary": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/workflows/{id}/versions

Published versions

Access: Signed-in members only (web or Android session) — not for API keys. Permission automations.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of WorkflowVersion
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/workflows/{id}/versions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "version": 0,
      "live": true,
      "published_at": "2026-10-06T05:30:00.000Z",
      "published_by": "string",
      "graph": {
        "format": 1,
        "nodes": [
          {
            "id": "string",
            "type": "string",
            "label": "string",
            "notes": "string",
            "position": {
              "x": null,
              "y": null
            },
            "config": {}
          }
        ],
        "edges": [
          {
            "id": "string",
            "source": "string",
            "target": "string",
            "handle": "string",
            "label": "string"
          }
        ]
      },
      "summary": [
        "string"
      ]
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.