Validate a template installation

Read-only validation of saved dependencies and destination field conflicts. Schema v3 also returns bindings[] (slots plus destination options), unresolvedBindingIds, and canInstall which requires every required slot to be decided. Legacy v1/v2 snapshots keep the prior blocker behavior. Grouped issues include context.locations.

POST

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

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

200

Successful operation. Schema v3 includes bindings, unresolvedBindingIds, and canInstall.

JSON

success
optional
boolean
canInstall
optional
boolean
unresolvedBindingIds
optional
array of
string
bindings
optional
array of
object
- id
  optional
  string
- kind
  optional
  sequence
  or
  flow
  or
  custom_field
- required
  optional
  boolean
- allow_skip
  optional
  boolean
- options
  optional
  array of
  object
- optionsTruncated
  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, incompatible destination fields, or undecided required binding slots; 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

curl --request POST \ --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/automation-templates/<templateId>/install/preview' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "destinationWorkspaceId": "string", "bindings": { "property1": { "action": "bind", "targetId": "cbca1126-180e-4334-9df8-cf82289d378b" }, "property2": { "action": "bind", "targetId": "cbca1126-180e-4334-9df8-cf82289d378b" } } } '

{ "success": true, "canInstall": true, "unresolvedBindingIds": [ "string" ], "bindings": [ { "id": "string", "kind": "sequence", "required": true, "allow_skip": true, "options": [ {} ], "optionsTruncated": true } ] }