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}

JWT

product:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the product.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the product.	min: 1, max: 256
displayName	string	Display name of the product, shown in the customer portal.	min: 1, max: 256
description	string	Description for the product.	min: 1, max: 256
licenseTemplateId	string	Unique identifier for the license template.	min: 1, max: 256
trialPolicyId	string	Unique identifier for the trial policy.	min: 0, max: 256
metadata	array	List of metdata key/value pairs.	items: object
key*	string	Name of the key.	min: 1, max: 256
value*	string	Value of the key.	min: 0, max: 4096
viewPermissions	array	Array of view permissions associated with the metadata.	items: string

Request Example

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "licenseTemplateId": "string",
  "licensePolicyId": "string",
  "trialPolicyId": "string",
  "metadata": [
    {
      "key": "string",
      "value": "string",
      "viewPermissions": [
        "activation"
      ],
      "visible": true
    }
  ]
}

Triggers webhook: product.updated

POST <your-webhook-url>
{
  "event": "product.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "publicKey": "string",
    "totalLicenses": 0,
    "totalTrialActivations": 0,
    "totalReleases": 0,
    "totalProductVersions": 0,
    "totalFeatureFlags": 0,
    "automatedEmails": [
      "string"
    ],
    "licenseTemplateId": "string",
    "trialPolicyId": "string",
    "iconUrl": "string",
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string",
        "viewPermissions": [
          "activation"
        ],
        "visible": true
      }
    ]
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "displayName": "string",
  "description": "string",
  "publicKey": "string",
  "totalLicenses": 0,
  "totalTrialActivations": 0,
  "totalReleases": 0,
  "totalProductVersions": 0,
  "totalFeatureFlags": 0,
  "automatedEmails": [
    "string"
  ],
  "licenseTemplateId": "string",
  "trialPolicyId": "string",
  "iconUrl": "string",
  "metadata": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "key": "string",
      "value": "string",
      "viewPermissions": [
        "activation"
      ],
      "visible": true
    }
  ]
}