Skip to content
First requestVisit website ↗
Navigation

Install an automation template

Checks source and destination access, then validates saved dependencies before any destination write. Schema v3 accepts bindings (bind + targetId, or skip) and applies them before remap. Undecided required slots return 409 unresolved_bindings with zero writes. Unresolved legacy dependencies return 409 with details.blockers and details.warnings. Installed sequences are drafts; resource-bundle webhooks are inactive.

POST
https://api.channelautomation.com/api/workspaces/{workspaceId}/automation-templates/{templateId}/install

Authorization

  • BearerAuth
    optional
    HTTP Bearer (JWT)
  • ApiKeyAuth
    optional
    API key in header

Path parameters

  • workspaceId
    string
    required
  • templateId
    string
    required
    format: uuid

Request body JSON required

  • destinationWorkspaceId
    string
    required
  • bindings
    optional
    map of
    object

    Schema v3 slot decisions keyed by binding id (seq:, flow:, field:, field-conflict:).

Returns

201

Successful operation. Schema v3 remap_report.bindings lists bound and skipped slots.

JSON
  • success
    optional
    boolean

400

Invalid selection or destination
JSON
  • success
    optional
    boolean
  • error
    optional
    string
  • details
    optional
    object
    or null

401

Authentication required
JSON
  • success
    optional
    boolean
  • error
    optional
    string
  • details
    optional
    object
    or null

403

Source and destination workspace access required
JSON
  • success
    optional
    boolean
  • error
    optional
    string
  • details
    optional
    object
    or null

404

Workspace, template or selected resource not found
JSON
  • success
    optional
    boolean
  • error
    optional
    string
  • details
    optional
    object
    or null

409

Unresolved dependencies or incompatible destination fields; details contains the repair issues
JSON
  • success
    optional
    boolean
  • error
    optional
    string
  • details
    optional
    object
    or null

500

Database or installation failure
JSON
  • success
    optional
    boolean
  • error
    optional
    string
  • details
    optional
    object
    or null

Type to search…

↑↓ navigate↵ selectEsc close