Developers
Products

Update a product

PATCH/products/{product_id}

Updates a product. Only the fields included in the request are changed. Setting deleted to false restores the product from the trash.

Changing status also requires the products.publish permission. Changing showcase_id or position also requires the showcases.update permission on the target showcase.

Replicated products accept only status; any other field returns the replica_readonly error code.

Send the current ETag value in the If-Match header to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Header Parameters

If-Match?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/products/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "definitions": null,    "deleted": true,    "display": null,    "external_id": "string",    "format": "course",    "id": "string",    "image": "string",    "lessons_count": 0,    "modules_count": 0,    "name": "string",    "object": "product",    "offer": null,    "position": 0,    "revision": "string",    "showcase_id": "string",    "status": "published",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a product GET

Retrieves a product by its public ID. The `offer` object is included only when the credentials have the `products.read_offer` permission. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the product to avoid overwriting a newer version.

Delete a product DELETE

Moves the product to the trash, together with its modules, its lessons, and its copies in replicated accounts. Users' access and reports related to the product are preserved. Restoring the product does not restore its copies in replicated accounts. Replicated products are read-only and cannot be deleted; these requests return the `replica_readonly` error code.