Skip to content
First requestVisit website ↗
Navigation

Analyze automation template selection

Expands referenced flows and sequences within the source workspace. Returns grouped dependency warnings with affected resources and steps; no data is written.

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

Authorization

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

Path parameters

  • workspaceId
    string
    required

Request body JSON required

  • flowIds
    optional
    array of
    string
    format: uuid
  • sequenceIds
    optional
    array of
    string
    format: uuid
  • folderIds
    optional
    array of
    string
    format: uuid
  • webhookIds
    optional
    array of
    string
    format: uuid
  • customInboxIds
    optional
    array of
    string
    format: uuid

Returns

200

Successful operation

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