---
title: "Install an automation template"
description: "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."
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.channelautomations.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Channel Automation API › Actions

`POST /api/workspaces/{workspaceId}/automation-templates/{templateId}/install`

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.

## Authentication

Requires one of the following:

- `BearerAuth`, http, header `Authorization`, format `JWT`
- `ApiKeyAuth`, apiKey, in header, header `X-API-Key`, format `API_KEY`

## Path parameters

- `workspaceId` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.path.workspaceId`; string, required)
- `templateId` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.path.templateId`; string, required)
  - format `uuid`

## Request body

_Required._

- `destinationWorkspaceId` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.destinationWorkspaceId`; string, required)
- `bindings` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.bindings`; map<object>, optional) — Schema v3 slot decisions keyed by binding id (seq:, flow:, field:, field-conflict:).

## Example request

```json
{
  "destinationWorkspaceId": "string",
  "bindings": {
    "property1": {
      "action": "bind",
      "targetId": "cbca1126-180e-4334-9df8-cf82289d378b"
    },
    "property2": {
      "action": "bind",
      "targetId": "cbca1126-180e-4334-9df8-cf82289d378b"
    }
  }
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/automation-templates/<templateId>/install' \
  --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"
    }
  }
}
'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/automation-templates/<templateId>/install';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    destinationWorkspaceId: 'string',
    bindings: {
      property1: {action: 'bind', targetId: 'cbca1126-180e-4334-9df8-cf82289d378b'},
      property2: {action: 'bind', targetId: 'cbca1126-180e-4334-9df8-cf82289d378b'}
    }
  })
};

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

### Python

```python
import requests

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

payload = {
    "destinationWorkspaceId": "string",
    "bindings": {
        "property1": {
            "action": "bind",
            "targetId": "cbca1126-180e-4334-9df8-cf82289d378b"
        },
        "property2": {
            "action": "bind",
            "targetId": "cbca1126-180e-4334-9df8-cf82289d378b"
        }
    }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)
```

## Responses

### 201

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

#### Example

```json
{
  "success": true
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.201.success`; boolean, optional)

### 400

Invalid selection or destination

#### Example

```json
{
  "success": true,
  "error": "string",
  "details": {}
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.400.success`; boolean, optional)
- `error` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.400.error`; string, optional)
- `details` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.400.details`; object, optional, nullable)

### 401

Authentication required

#### Example

```json
{
  "success": true,
  "error": "string",
  "details": {}
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.401.success`; boolean, optional)
- `error` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.401.error`; string, optional)
- `details` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.401.details`; object, optional, nullable)

### 403

Source and destination workspace access required

#### Example

```json
{
  "success": true,
  "error": "string",
  "details": {}
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.403.success`; boolean, optional)
- `error` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.403.error`; string, optional)
- `details` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.403.details`; object, optional, nullable)

### 404

Workspace, template or selected resource not found

#### Example

```json
{
  "success": true,
  "error": "string",
  "details": {}
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.404.success`; boolean, optional)
- `error` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.404.error`; string, optional)
- `details` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.404.details`; object, optional, nullable)

### 409

Unresolved dependencies or incompatible destination fields; details contains the repair issues

#### Example

```json
{
  "success": true,
  "error": "string",
  "details": {}
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.409.success`; boolean, optional)
- `error` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.409.error`; string, optional)
- `details` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.409.details`; object, optional, nullable)

### 500

Database or installation failure

#### Example

```json
{
  "success": true,
  "error": "string",
  "details": {}
}
```

- `success` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.500.success`; boolean, optional)
- `error` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.500.error`; string, optional)
- `details` (`post/api/workspaces/workspaceId/automation-templates/templateId/install.response.500.details`; object, optional, nullable)


Source: https://developer.channelautomations.com/api/post-api-workspaces-workspace-id-automation-templates-template-id-install/index.md