Save a product with the given ID

This endpoint both saves and updates a product. The product is identified by the id path parameter. If the product ID does not exist, then a new product with the corresponding ID will be created. Otherwise, the existing product will be modified.

SecurityZephrHmacHttp
Request
path Parameters
id
required
string

Unique Product identifier.

Request Body schema: application/json
label
required
string

The product label. This is the human-readable name of the product.

description
string

The product description. This is a human-readable description of the product.

required
object (product.entitlement)
required
object (product.mapping)
sharingLimit
number

The number of other users that the purchaser of this product can share the product with.

Responses
200

OK. The product was updated.

201

Created. The product was created.

400

Bad Request. Returned if the request body is invalid.

401

Unauthorized. Returned if no valid authentication was provided.

409

Conflict. Returned when missing a reference to the entitlement.

put/v3/products/{id}
Request samples
application/json
{
  • "label": "Gold Subscription",
  • "description": "The most premium subscription.",
  • "entitlement": {
    },
  • "mapping": {
    },
  • "sharingLimit": 5
}
Response samples
application/json
{}