Update a product

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

PATCH/v3/products/{id}
JWTproduct:write

Path parameters

idstringrequired

Unique identifier for the product.

Request body

namestring

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

Length: [1,256]Pattern: ^[a-zA-Z0-9_.-]+( +[a-zA-Z0-9_.-]+)*$

displayNamestring

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.

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

descriptionstring

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.

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

iconUrlstring

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

Length: [0,256]Format: uri

licenseTemplateIdstring

Unique identifier for the license template.

Length: [1,256]

trialPolicyIdstring

Unique identifier for the trial policy.

Length: [0,256]

metadataarray of object

List of metdata key/value pairs.

customAttributesarray of object

List of custom attribute name/value pairs.

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
displayNamestringrequired
descriptionstringrequired
publicKeystringrequired
totalLicensesintegerrequired

Format: int32

totalTrialActivationsintegerrequired

Format: int32

totalReleasesintegerrequired

Format: int32

totalProductVersionsintegerrequired

Format: int32

totalFeatureFlagsintegerrequired

Format: int32

automatedEmailsarray of stringrequired
licenseTemplateIdstringrequired
trialPolicyIdstringrequired
metadataarray of objectrequired
customAttributesarray of objectrequired
iconUrlstring