Update a release channel

Updates the specified release channel by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/release-channels/{id}
JWTrelease:write

Path parameters

idstringrequired

Unique identifier for the release channel.

Request body

descriptionstring

Description for the channel. Any printable characters and line breaks. Cannot contain control characters other than tab, carriage return and line feed, nor invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [0,256]Pattern: ^(?!\s)(?![\s\S]*\s$)(?:[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]|[\t\n\r])+$

displayNamestring

Display name of the channel. Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

privateboolean

Private channels don't appear in the customer portal.

productIdsarray of string

Array of product IDs to associate with this release channel.

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
displayNamestringrequired
descriptionstringrequired
privatebooleanrequired
productIdsarray of stringrequired