ProductVersions

Update a product version

Changed on

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

patch/v3/product-versions/{id}

Request

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

Path parameters

idstring required

Unique identifier for the product version.

Request body

namestring nullable

Name of the product version.

Letters (a-z, A-Z), numbers, underscores, hyphens, dots and spaces. Cannot start or end with a space.

displayNamestring nullable

Display name of the product version, shown in the customer portal.

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.

descriptionstring nullable

Description for the product version.

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.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
displayNamestring required
descriptionstring required
productIdstring required

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

    • breaking

      added the pattern ^[a-zA-Z0-9_-]+$ to the request property //

    • breaking

      added the pattern ^[a-zA-Z0-9_.-]+( +[a-zA-Z0-9_.-]+)*$ to the request property

    • breaking

      the // request property's minLength was increased from 0 to 1

    • 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 request property

    • info

      endpoint deprecated

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • 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

      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