Automations

Rename an automation or set its icon

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

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

Path parameters

automationIdstring required

Automation ID

Headers

Idempotency-Keystring

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

namestring

The new name

iconstring nullable

An icon id (lucide:…, emoji:…); null clears it

Response

The automation’s name and icon

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.