---
title: "Rename an automation or set its icon"
method: PATCH
path: "/v1/automations/{automationId}"
tags: ["Automations"]
---

# Rename an automation or set its icon

`PATCH /v1/automations/{automationId}`

## Request

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

Change the name, the icon, or both, that the library and the builder show; `icon: null` clears it. The definition is not changed.

## 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.

## Request body

- object
  - `name` string: The new name
  - `icon` string, nullable: An icon id (`lucide:…`, `emoji:…`); null clears it

## Response `200`

The automation’s name and icon

- object
  - `success` true, required
  - `data` object, required
    - `automation` object, required
      - `id` string, required
      - `name` string, required
      - `icon` string, nullable, required

## 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)