Skip to main content

Update Channel

Update an existing deployment channel's name.

warning

Changing the channel name may disrupt existing client apps' ability to check for new versions due to the altered channel name.

Endpoint​

POST /channel/update

Authentication​

HeaderValue
AuthorizationBearer <jwt_token>

Request Body​

The request uses application/json format with the following fields:

FieldTypeRequiredDescription
idstring✅The ID of the channel to update
channelstring✅The new name for the channel

Example Request​

curl --location 'http://localhost:9000/channel/update' \
-H "Authorization: Bearer <jwt_token>" \
-H "Content-Type: application/json" \
--data '{
"id": "66ae13fe4b663c058367f893",
"channel": "new_name"
}'

Response​

Success Response (200 OK)​

{
"updateChannelResult.Updated": true
}

Response Fields​

FieldTypeDescription
updateChannelResult.UpdatedbooleanIndicates whether the channel was successfully updated

Notes​

  • Channel name changes should be done carefully as they may break existing client integrations
  • The change affects all future uploads and searches using this channel