---
title: "Updates an existing Channel"
method: PUT
path: "/channels/{id}"
tags: ["Channels"]
---

# Updates an existing Channel

`PUT /channels/{id}`

## Path parameters

- `id` string, required

## Request body

- ModifyChannelCommand
  - `AutomaticEphemeralEnvironmentDeployments` boolean
  - `CustomFieldDefinitions` ChannelCustomFieldDefinitionResource[]
    - `Description` string
    - `FieldName` string
  - `Description` string
  - `EphemeralEnvironmentNameTemplate` string
  - `GitReferenceRules` string[]
  - `GitResourceRules` ChannelGitResourceRuleResource[]
    - `GitDependencyActions` DeploymentActionGitDependencyResource[]
      - `DeploymentActionSlug` string, required
      - `GitDependencyName` string, required
    - `Id` string
    - `Rules` string[]
  - `Id` string, required
  - `IsDefault` boolean
  - `LifecycleId` string — The lifecycle for this channel. Must be null for ephemeral environment channels.
  - `Name` string, required
  - `ParentEnvironmentId` string — The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.
  - `ProjectId` string, required
  - `Rules` ChannelVersionRuleResource[]
    - `ActionPackages` DeploymentActionPackageResource[]
      - `DeploymentAction` string
      - `PackageReference` string
    - `Id` string
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `Tag` string
    - `VersioningStrategy` string
    - `VersionRange` string
    - `VersionTagRegex` string
  - `Slug` string
  - `SpaceId` string, required
  - `TenantTags` string[]

## Response `200`

Confirms the Channel was modified, containing the updated Channel

- ChannelResource
  - `AutomaticEphemeralEnvironmentDeployments` boolean
  - `CustomFieldDefinitions` ChannelCustomFieldDefinitionResource[]
    - `Description` string
    - `FieldName` string
  - `Description` string
  - `EphemeralEnvironmentNameTemplate` string
  - `GitReferenceRules` string[]
  - `GitResourceRules` ChannelGitResourceRuleResource[]
    - `GitDependencyActions` DeploymentActionGitDependencyResource[]
      - `DeploymentActionSlug` string, required
      - `GitDependencyName` string, required
    - `Id` string
    - `Rules` string[]
  - `Id` string
  - `IsDefault` boolean
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `LifecycleId` string
  - `Links` object
  - `Name` string
  - `ParentEnvironmentId` string — The parent environment for all ephemeral environments created in this channel.
  - `ProjectId` string
  - `Rules` ChannelVersionRuleResource[]
    - `ActionPackages` DeploymentActionPackageResource[]
      - `DeploymentAction` string
      - `PackageReference` string
    - `Id` string
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `Tag` string
    - `VersioningStrategy` string
    - `VersionRange` string
    - `VersionTagRegex` string
  - `Slug` string
  - `SpaceId` string
  - `TenantTags` string[]
  - `Type` string

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)