---
title: "Activate an automation"
method: POST
path: "/v1/automations/{automationId}/activate"
tags: ["Automations"]
---

# Activate an automation

`POST /v1/automations/{automationId}/activate`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/automations/{automationId}/activate`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Register the active revision’s triggers: schedules fire, BankSync events and table changes start runs, webhooks answer. A webhook’s URL is in `webhooks`, by trigger ref, once — store it; activating again keeps it. Runs need the grant approved by a member.

## Path parameters

- `automationId` string, required: Automation ID

## Headers

- `Idempotency-Key` string: Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 `IDEMPOTENCY_KEY_REUSED`. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

## Response `200`

Active

- object
  - `success` true, required
  - `data` object, required
    - `status` 'draft' | 'inactive' | 'active' | 'blocked', required: `draft`: never published. `inactive`: published, triggers off. `active`: triggers registered. `blocked`: on, but its grant does not let it run.
    - `triggers` object[], required
      - `nodeId` string, required
      - `ref` string, required: The trigger’s ref: `webhooks` is keyed by it.
      - `strategy` string, required
      - `nextFireAt` string, nullable, required
    - `webhooks` object, required: Webhook URLs minted now, by trigger ref. Shown once: store them.
    - `warnings` string[]: What turning it on does not do, in words: e.g. a feed another automation already runs on its schedule. Show them; the automation is on.

## Other responses

- `400`: Invalid input, or the draft has blocking findings — `code` names the refusal (`AUTOMATION_BLOCKED_BY_FINDINGS`, `AUTOMATION_SECRET_REFUSED`, …) and `details[]` each finding with its node
- `401`: Unauthorized
- `403`: Forbidden — missing scope, insufficient role, a credential narrowed to some accounts, or a grant the caller does not hold
- `404`: Not found — or automations are not enabled for this workspace
- `409`: Conflict — the draft moved since you read it (`AUTOMATION_VERSION_CONFLICT`), the automation is not published or not active, or a grant does not hold (`AUTOMATION_GRANT_STATE`)
- `429`: The automation’s admission refused the run and does not queue (`AUTOMATION_ADMISSION_REFUSED`, `AUTOMATION_RATE_LIMITED`): `code` names which, and the `Retry-After` header says how many seconds to wait before trying again. A start that queues is a 202, not this.
- `503`: Automations are paused while an incident is worked (`AUTOMATIONS_STOPPED`) or not configured here (`AUTOMATIONS_UNAVAILABLE`): `code` names which, and the `Retry-After` header says how many seconds to wait before retrying

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)