CRcryptlex
Products

Update a product

Changed on

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

patch/v3/products/{id}

Request

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

Path parameters

idstring required

Unique identifier for the product.

Request body

namestring nullable

Name of the product.

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, 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, shown in the customer portal.

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.

iconUrlstring uri nullable

URL of the product icon, used in the customer portal.

licenseTemplateIdstring nullable

Unique identifier for the license template.

licensePolicyIdstring nullable

Use 'licenseTemplateId' instead.

trialPolicyIdstring nullable

Unique identifier for the trial policy.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
displayNamestring required
descriptionstring required
iconUrlstring nullable
publicKeystring required
totalLicensesinteger required
totalTrialActivationsinteger required
totalReleasesinteger required
totalProductVersionsinteger required
totalFeatureFlagsinteger required
automatedEmailsstring[] required
licenseTemplateIdstring required
trialPolicyIdstring required

Changes

  • 0088bcd57a3cRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

  • a25b6aaa706cRevision changes
    • info

      the // request property's maxLength was increased from 4096 to 8192