Preview install-time bindings for an unsaved selection

Read-only. Re-runs the selection capture on the server and returns the schema v3 binding plan for a destination workspace (slots with destination options, field conflicts, target validation, canInstall). Used by the Create modal's inline install before the template exists. Nothing is written.

POST

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

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header

Path parameters

workspaceId
string
required

Request body JSON required

destinationWorkspaceId
string
required
bindings
optional
map of
object
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

Binding plan for the destination

JSON

success
optional
boolean
canInstall
optional
boolean
unresolvedBindingIds
optional
array of
string
bindings
optional
array of
object
blockers
optional
array of
object
warnings
optional
array of
object

400

Invalid selection or destination

401

Authentication required

403

Source and destination workspace access required

Preview install-time bindings for an unsaved selection

curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/automation-templates/analyze/install-preview' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destinationWorkspaceId": "string",
  "bindings": {
    "property1": {
      "action": "bind",
      "targetId": "string"
    },
    "property2": {
      "action": "bind",
      "targetId": "string"
    }
  },
  "flowIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "sequenceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "folderIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "webhookIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "customInboxIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}
'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/automation-templates/analyze/install-preview';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    destinationWorkspaceId: 'string',
    bindings: {
      property1: {action: 'bind', targetId: 'string'},
      property2: {action: 'bind', targetId: 'string'}
    },
    flowIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],
    sequenceIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],
    folderIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],
    webhookIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],
    customInboxIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08']
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspaces/<workspaceId>/automation-templates/analyze/install-preview"

payload = {
    "destinationWorkspaceId": "string",
    "bindings": {
        "property1": {
            "action": "bind",
            "targetId": "string"
        },
        "property2": {
            "action": "bind",
            "targetId": "string"
        }
    },
    "flowIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "sequenceIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "folderIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "webhookIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "customInboxIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"]
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "canInstall": true,
  "unresolvedBindingIds": [
    "string"
  ],
  "bindings": [
    {}
  ],
  "blockers": [
    {}
  ],
  "warnings": [
    {}
  ]
}