# helpers

> Automations: triggers, steps, versions, test mode and go-live.

Automations: triggers, steps, versions, test mode and go-live.

| Method | Path | Operation | Scope | Test mode |
|---|---|---|---|---|
| GET | `/v1/helper-pauses` | `helper_pauses_list`: Bulk pauses of automations | `helpers:read` | - |
| GET | `/v1/helper-pauses/{pause_id}` | `helper_pauses_get`: One bulk pause | `helpers:read` | - |
| POST | `/v1/helper-pauses/{pause_id}/resume` | `helper_pauses_resume`: Resume: turn back on exactly what this pause turned off | `helpers:run` | - |
| GET | `/v1/helpers` | `helpers_list`: List helpers | `helpers:read` | - |
| POST | `/v1/helpers` | `helpers_create`: Create a helper from scratch or from a recipe | `helpers:write` | - |
| POST | `/v1/helpers:bulk-deactivate` | `helpers_bulk_deactivate`: Pause chosen automations in one step (reversible) | `helpers:run` | - |
| POST | `/v1/helpers:generate` | `helpers_generate`: Say it and AI builds it | `helpers:write` | - |
| DELETE | `/v1/helpers/{helper_id}` | `helpers_delete`: Delete a helper (runs are retained for 30 days) | `helpers:write` | - |
| GET | `/v1/helpers/{helper_id}` | `helpers_get`: Get a helper with its current and draft version | `helpers:read` | - |
| PATCH | `/v1/helpers/{helper_id}` | `helpers_update`: Update name, description, folder, channel scope and guards | `helpers:write` | - |
| POST | `/v1/helpers/{helper_id}/activate` | `helpers_activate`: Publish a version and turn the helper on | `helpers:run` | - |
| POST | `/v1/helpers/{helper_id}/deactivate` | `helpers_deactivate`: Turn the helper off; waiting runs are cancelled or drained | `helpers:run` | - |
| GET | `/v1/helpers/{helper_id}/stats` | `helpers_stats`: Runs, success rate, average time, top failing step (last 30 days) | `helpers:read` | - |
| POST | `/v1/helpers/{helper_id}/test` | `helpers_test`: Dry-run against a sample contact or event | `helpers:run` | - |
| POST | `/v1/helpers/{helper_id}/trigger` | `helpers_trigger`: Start the helper for a contact (API / Zapier action) | `helpers:run` | - |
| POST | `/v1/helpers/{helper_id}/validate` | `helpers_validate`: Static check: unreachable steps, loops, missing ready messages, window risks, step cap | `helpers:read` | - |
| GET | `/v1/helpers/{helper_id}/versions` | `helpers_list_versions`: List versions (newest first) | `helpers:read` | - |
| POST | `/v1/helpers/{helper_id}/versions` | `helpers_save_version`: Save the draft version (validated against the graph schema) | `helpers:write` | - |
| GET | `/v1/helpers/{helper_id}/versions/{a}/diff/{b}` | `helpers_diff_versions`: Plain-language diff between two versions | `helpers:read` | - |
| GET | `/v1/helpers/{helper_id}/versions/{version_id}` | `helpers_get_version`: Get one version with its graph | `helpers:read` | - |
| POST | `/v1/helpers/{helper_id}/versions/{version_id}/restore` | `helpers_restore_version`: Restore a version as the new draft | `helpers:write` | - |
| GET | `/v1/helpers/linked` | `helpers_list_linked`: Automations edited elsewhere (fee-plan reminders, comment auto-replies) | `helpers:read` | - |
| GET | `/v1/helpers/recipes` | `helpers_list_recipes`: Ready-made recipes with their required inputs | `helpers:read` | - |
| POST | `/v1/helpers/recipes/{recipe_id}/preview` | `helpers_preview_recipe`: See exactly what a recipe will do, before anything is created | `helpers:read` | - |
| GET | `/v1/helpers/steps` | `helpers_list_steps`: Step types catalogue | `helpers:read` | - |
| GET | `/v1/helpers/triggers` | `helpers_list_triggers`: Trigger types catalogue | `helpers:read` | - |

Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`.
