CRcryptlex
ReleaseChannels

Update a release channel

Changed on

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}

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/release-channels/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for the release channel.

Request body

descriptionstring nullable

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.

displayNamestring nullable

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.

privateboolean nullable

Private channels don't appear in the customer portal.

productIdsstring[] nullable

Array of product IDs to associate with this release channel.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
displayNamestring required
descriptionstring required
privateboolean required
productIdsstring[] required

Changes

  • 66dcb6293180Revision changes
    • breaking

      added the pattern ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$ to the request property

    • breaking

      added the pattern ^(?!\s)(?![\s\S]*\s$)(?:[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]|[\t\n\r])+$ to the request property

  • ec1259c12475Revision changes
    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status