Skip to content

Save a product with the given ID

Request

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.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Product identifier.

Bodyapplication/json
labelstringrequired

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

Example:"Gold Subscription"
descriptionstring

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

Example:"The most premium subscription."
entitlementobject(product.entitlement)required
mappingobject(product.mapping)required
Example:
{ "braintree_one_off": { "price_points": [ … ] } }
sharingLimitnumber

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

Example:5
{ "label": "Gold Subscription", "description": "The most premium subscription.", "entitlement": { "id": "gold-bundle", "type": "bundle", "entitlementTenant": "company" }, "mapping": { "braintree_one_off": { … } }, "sharingLimit": 5 }

Responses

OK. The product was updated.

Headers
any
Bodyapplication/json
messagestring
Example:"Product updated successfully"
uristring
Example:"https://company.api.zephr.com/v3/products/gold"
Response
{ "message": "Product updated successfully", "uri": "https://company.api.zephr.com/v3/products/gold" }