Automations

Bind a resource

Point a declared binding at a resource of this workspace — a table, a view, a bank, a feed, a connection or another automation. It must exist here and be of the declared type. targetId: null unbinds it while the automation is off.

put/v1/automations/{automationId}/bindings/{name}

Request

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

Path parameters

automationIdstring required

Automation ID

namestring required

The binding’s declared name

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

targetIdstring nullable required

The id of a resource or connection of this workspace, of the declared type; null unbinds it.

Response

Bound

successtrue required

Changes

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