Change a channel's settings or target - Veryfront

updateChannel(projectReference: ID!, channelId: ID!, input: UpdateChannelInput!): Channel!

Requires project.channels.write.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project UUID or slug.
`channelId`	`ID!`	Yes
`input`	`UpdateChannelInput!`	Yes

Input fields

input

UpdateChannelInput

Field	Type	Required	Description
`name`	`String`	No
`agentId`	`String`	No	Agent checked again against the selected runtime target.
`respondTo`	`ChannelRespondTo`	No
`allowedSlackChannelIds`	`[String!]`	No	Slack channel IDs. Overlap with another channel in the same workspace is rejected with resource-already-exists. At most 250 IDs; empty means every Slack channel the bot is in. A preview_branch target needs at least one.
`welcomeMessage`	`String`	No
`errorMessage`	`String`	No
`maxResponseTokens`	`Int`	No
`runtimeTargetKind`	`RuntimeTargetKind`	No	Selected target; the agent is checked against it again.
`targetEnvironmentId`	`ID`	No
`targetBranchId`	`ID`	No

Response

Returns Channel!. Open the type for its fields and nested types.

Field	Type	Description
`id`	`ID!`
`projectId`	`ID!`
`platform`	`ChannelPlatform!`
`name`	`String`
`agentId`	`String`	Project agent that answers in this channel.
`enabled`	`Boolean!`	Always true today; kept for forward compatibility.
`status`	`ChannelStatus!`
`installationId`	`ID`

All fields of Channel. Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation UpdateChannel($projectReference: ID!, $channelId: ID!, $input: UpdateChannelInput!) {
  updateChannel(projectReference: $projectReference, channelId: $channelId, input: $input) {
    id
    projectId
    agentId
    name
    status
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "channelId": "00000000-0000-4000-8000-000000000001",
  "input": {}
}