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

# Change a channel's settings or target

> Update a channel binding.

`veryfront__update_channel`

Requires project.channels.write.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Can change resources.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `project_reference` | `string` | No | Project ID or slug |
| `channel_id` | `string` | Yes | Channel ID from [`list_channels`](/docs/cloud/mcp/tools/list-channels) Format: `uuid`. |
| `agent_id` | `string` | No | Agent ID from listChannelAgents (MCP: [`list_channel_agents`](/docs/cloud/mcp/tools/list-channel-agents)) for the same runtime target Minimum length: `1`. |
| `name` | `string` | No | Display name, 1-255 characters Minimum length: `1`. Maximum length: `255`. |
| `assistant_id` | `string` | No | Deprecated alias of `agent_id` (CR-channel-field-aliases). Minimum length: `1`. |
| `respond_to` | `string` | No | Which Slack messages to answer: mentions, `direct_messages` or all Values: `"mentions"`, `"direct_messages"`, `"all"`. |
| `allowed_slack_channel_ids` | `string[]` | No | Slack channel IDs. Overlap with another channel in the same workspace is rejected with resource-already-exists. IDs come from listSlackChannels (MCP: [`list_slack_channels`](/docs/cloud/mcp/tools/list-slack-channels)); empty means every Slack channel the bot is in. A `preview_branch` target needs at least one. |
| `allowed_channels` | `string[]` | No | Deprecated alias of `allowed_slack_channel_ids` (CR-channel-field-aliases). |
| `welcome_message` | `string or null` | No | Welcome message; null clears |
| `error_message` | `string or null` | No | Message shown when the agent fails; null clears |
| `max_response_tokens` | `integer or null` | No | Maximum response tokens, 1-65536; null clears |
| `runtime_target_kind` | `string` | No | Runtime target: `main_branch`, environment or `preview_branch` Values: `"main_branch"`, `"environment"`, `"preview_branch"`. |
| `target_environment_id` | `string or null` | No | Environment ID; required when `runtime_target_kind` is environment |
| `target_branch_id` | `string or null` | No | Branch ID; required when `runtime_target_kind` is `preview_branch` |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__update_channel",
    "arguments": {
      "channel_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `id` | `string` | Yes | Unique identifier for the returned record. Format: `uuid`. |
| `project_id` | `string` | Yes | Project identifier associated with this result. Format: `uuid`. |
| `binding_id` | `string` | Yes | The binding id returned by the tool. Format: `uuid`. |
| `installation_id` | `string or null` | Yes | The installation id returned by the tool. |
| `platform` | `string` | Yes | The platform returned by the tool. Values: `"slack"`. |
| `name` | `string or null` | Yes | Human-readable name for the returned record. |
| `agent_id` | `string or null` | Yes | The agent id returned by the tool. |
| `assistant_id` | `string or null` | Yes | The assistant id returned by the tool. |
| `enabled` | `boolean` | Yes | The enabled returned by the tool. |
| `platform_team_id` | `string or null` | Yes | The platform team id returned by the tool. |
| `platform_bot_id` | `string or null` | Yes | The platform bot id returned by the tool. |
| `workspace_name` | `string or null` | Yes | The workspace name returned by the tool. |
| `respond_to` | `string` | Yes | The respond to returned by the tool. Values: `"mentions"`, `"direct_messages"`, `"all"`. |
| `allowed_slack_channel_ids` | `string[]` | Yes | List of allowed slack channel ids returned by the tool. |
| `allowed_channels` | `string[]` | Yes | List of allowed channels returned by the tool. |
| `status` | `string` | Yes | Lifecycle status for the returned record. Values: `"connected"`, `"needs_reauth"`, `"error"`. |
| `welcome_message` | `string or null` | Yes | The welcome message returned by the tool. |
| `error_message` | `string or null` | Yes | The error message returned by the tool. |
| `max_response_tokens` | `integer or null` | Yes | The max response tokens returned by the tool. |
| `runtime_target_kind` | `string` | Yes | The runtime target kind returned by the tool. Values: `"main_branch"`, `"environment"`, `"preview_branch"`. |
| `target_environment_id` | `string or null` | Yes | The target environment id returned by the tool. |
| `target_branch_id` | `string or null` | Yes | The target branch id returned by the tool. |
| `resolved_target` | `object` | Yes | Structured resolved target details returned by the tool. |
| `created_at` | `string` | Yes | Creation timestamp in ISO 8601 format. |
| `updated_at` | `string` | Yes | Last update timestamp in ISO 8601 format. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "channel_id": {
      "type": "string",
      "format": "uuid",
      "description": "Channel ID from list_channels"
    },
    "agent_id": {
      "type": "string",
      "minLength": 1,
      "description": "Agent ID from listChannelAgents (MCP: list_channel_agents) for the same runtime target"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Display name, 1-255 characters"
    },
    "assistant_id": {
      "type": "string",
      "minLength": 1,
      "description": "Deprecated alias of agent_id (CR-channel-field-aliases)."
    },
    "respond_to": {
      "type": "string",
      "enum": [
        "mentions",
        "direct_messages",
        "all"
      ],
      "description": "Which Slack messages to answer: mentions, direct_messages or all"
    },
    "allowed_slack_channel_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "description": "One allowed slack channel id item supplied to the tool."
      },
      "maxItems": 250,
      "description": "Slack channel IDs. Overlap with another channel in the same workspace is rejected with resource-already-exists. IDs come from listSlackChannels (MCP: list_slack_channels); empty means every Slack channel the bot is in. A preview_branch target needs at least one."
    },
    "allowed_channels": {
      "$ref": "#/properties/allowed_slack_channel_ids",
      "description": "Deprecated alias of allowed_slack_channel_ids (CR-channel-field-aliases)."
    },
    "welcome_message": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4000,
          "description": "Provide the welcome message."
        },
        {
          "type": "null",
          "description": "Provide the welcome message."
        }
      ],
      "description": "Welcome message; null clears"
    },
    "error_message": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4000,
          "description": "Provide the error message."
        },
        {
          "type": "null",
          "description": "Provide the error message."
        }
      ],
      "description": "Message shown when the agent fails; null clears"
    },
    "max_response_tokens": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 65536,
          "description": "Provide the max response tokens."
        },
        {
          "type": "null",
          "description": "Provide the max response tokens."
        }
      ],
      "description": "Maximum response tokens, 1-65536; null clears"
    },
    "runtime_target_kind": {
      "type": "string",
      "enum": [
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Runtime target: main_branch, environment or preview_branch"
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Environment ID; required when runtime_target_kind is environment"
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Branch ID; required when runtime_target_kind is preview_branch"
    }
  },
  "required": [
    "channel_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the update_channel tool."
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Project identifier associated with this result."
    },
    "binding_id": {
      "type": "string",
      "format": "uuid",
      "description": "The binding id returned by the tool."
    },
    "installation_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The installation id returned by the tool."
        },
        {
          "type": "null",
          "description": "The installation id returned by the tool."
        }
      ],
      "description": "The installation id returned by the tool."
    },
    "platform": {
      "type": "string",
      "enum": [
        "slack"
      ],
      "description": "The platform returned by the tool."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Human-readable name for the returned record."
    },
    "agent_id": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "description": "The agent id returned by the tool."
        },
        {
          "type": "null",
          "description": "The agent id returned by the tool."
        }
      ],
      "description": "The agent id returned by the tool."
    },
    "assistant_id": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "description": "The assistant id returned by the tool."
        },
        {
          "type": "null",
          "description": "The assistant id returned by the tool."
        }
      ],
      "description": "The assistant id returned by the tool."
    },
    "enabled": {
      "type": "boolean",
      "description": "The enabled returned by the tool."
    },
    "platform_team_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The platform team id returned by the tool."
    },
    "platform_bot_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The platform bot id returned by the tool."
    },
    "workspace_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The workspace name returned by the tool."
    },
    "respond_to": {
      "type": "string",
      "enum": [
        "mentions",
        "direct_messages",
        "all"
      ],
      "description": "The respond to returned by the tool."
    },
    "allowed_slack_channel_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One allowed slack channel id item returned by the tool."
      },
      "description": "List of allowed slack channel ids returned by the tool."
    },
    "allowed_channels": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One allowed channel item returned by the tool."
      },
      "description": "List of allowed channels returned by the tool."
    },
    "status": {
      "type": "string",
      "enum": [
        "connected",
        "needs_reauth",
        "error"
      ],
      "description": "Lifecycle status for the returned record."
    },
    "welcome_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "The welcome message returned by the tool."
    },
    "error_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "The error message returned by the tool."
    },
    "max_response_tokens": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "description": "The max response tokens returned by the tool."
        },
        {
          "type": "null",
          "description": "The max response tokens returned by the tool."
        }
      ],
      "description": "The max response tokens returned by the tool."
    },
    "runtime_target_kind": {
      "type": "string",
      "enum": [
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "The runtime target kind returned by the tool."
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The target environment id returned by the tool."
        },
        {
          "type": "null",
          "description": "The target environment id returned by the tool."
        }
      ],
      "description": "The target environment id returned by the tool."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The target branch id returned by the tool."
        },
        {
          "type": "null",
          "description": "The target branch id returned by the tool."
        }
      ],
      "description": "The target branch id returned by the tool."
    },
    "resolved_target": {
      "type": "object",
      "properties": {
        "runtime_target": {
          "type": "object",
          "properties": {
            "kind": {
              "$ref": "#/properties/runtime_target_kind",
              "description": "The kind returned by the tool."
            },
            "target_environment_id": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uuid",
                  "description": "The target environment id returned by the tool."
                },
                {
                  "type": "null",
                  "description": "The target environment id returned by the tool."
                }
              ],
              "description": "The target environment id returned by the tool."
            },
            "target_branch_id": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uuid",
                  "description": "The target branch id returned by the tool."
                },
                {
                  "type": "null",
                  "description": "The target branch id returned by the tool."
                }
              ],
              "description": "The target branch id returned by the tool."
            }
          },
          "required": [
            "kind",
            "target_environment_id",
            "target_branch_id"
          ],
          "additionalProperties": false,
          "description": "Structured runtime target details returned by the tool."
        },
        "resolved_environment": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Unique identifier for the returned record."
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Human-readable name for the returned record."
                }
              },
              "required": [
                "id",
                "name"
              ],
              "additionalProperties": false,
              "description": "Structured resolved environment details returned by the tool."
            },
            {
              "type": "null",
              "description": "The resolved environment returned by the tool."
            }
          ],
          "description": "The resolved environment returned by the tool."
        },
        "resolved_branch": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Unique identifier for the returned record."
                },
                "name": {
                  "type": "string",
                  "description": "Human-readable name for the returned record."
                }
              },
              "required": [
                "id",
                "name"
              ],
              "additionalProperties": false,
              "description": "Structured resolved branch details returned by the tool."
            },
            {
              "type": "null",
              "description": "The resolved branch returned by the tool."
            }
          ],
          "description": "The resolved branch returned by the tool."
        },
        "resolved_deployment": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the returned record."
                },
                "runtime_version": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The runtime version returned by the tool."
                },
                "deployment_revision": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The deployment revision returned by the tool."
                },
                "last_deployed_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The last deployed at returned by the tool."
                }
              },
              "required": [
                "id",
                "runtime_version",
                "deployment_revision",
                "last_deployed_at"
              ],
              "additionalProperties": false,
              "description": "Structured resolved deployment details returned by the tool."
            },
            {
              "type": "null",
              "description": "The resolved deployment returned by the tool."
            }
          ],
          "description": "The resolved deployment returned by the tool."
        },
        "resolved_managed_domain": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "domain": {
                  "type": "string",
                  "description": "The domain returned by the tool."
                },
                "health_url": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The health url returned by the tool."
                }
              },
              "required": [
                "domain",
                "health_url"
              ],
              "additionalProperties": false,
              "description": "Structured resolved managed domain details returned by the tool."
            },
            {
              "type": "null",
              "description": "The resolved managed domain returned by the tool."
            }
          ],
          "description": "The resolved managed domain returned by the tool."
        },
        "resolved_invoke_mode": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "dispatch_override",
                "managed_domain"
              ],
              "description": "The resolved invoke mode returned by the tool."
            },
            {
              "type": "null",
              "description": "The resolved invoke mode returned by the tool."
            }
          ],
          "description": "The resolved invoke mode returned by the tool."
        },
        "last_resolution_error": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "The code returned by the tool."
                },
                "retryable": {
                  "type": "boolean",
                  "description": "The retryable returned by the tool."
                },
                "message": {
                  "type": "string",
                  "description": "The message returned by the tool."
                }
              },
              "required": [
                "code",
                "retryable",
                "message"
              ],
              "additionalProperties": false,
              "description": "Structured last resolution error details returned by the tool."
            },
            {
              "type": "null",
              "description": "The last resolution error returned by the tool."
            }
          ],
          "description": "The last resolution error returned by the tool."
        }
      },
      "required": [
        "runtime_target",
        "resolved_environment",
        "resolved_branch",
        "resolved_deployment",
        "resolved_managed_domain",
        "resolved_invoke_mode",
        "last_resolution_error"
      ],
      "additionalProperties": false,
      "description": "Structured resolved target details returned by the tool."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp in ISO 8601 format."
    }
  },
  "required": [
    "id",
    "project_id",
    "binding_id",
    "installation_id",
    "platform",
    "name",
    "agent_id",
    "assistant_id",
    "enabled",
    "platform_team_id",
    "platform_bot_id",
    "workspace_name",
    "respond_to",
    "allowed_slack_channel_ids",
    "allowed_channels",
    "status",
    "welcome_message",
    "error_message",
    "max_response_tokens",
    "runtime_target_kind",
    "target_environment_id",
    "target_branch_id",
    "resolved_target",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the update_channel tool."
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__update_channel` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run this tool with these arguments.

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.