Copy a product
/products/{product_id}/copiesStarts an asynchronous copy of the product, with the given name, into the target showcase in the same account.
The response returns an operation. Track it through the URL in the Location header; when the operation completes, its result includes the copy_id of the new product.
Replicated products cannot be copied and replicated showcases cannot receive copies; these requests return the replica_readonly error code.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request 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
curl -X POST "https://example.com/products/string/copies" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "showcase_id": "string" }'{ "data": { "attempt": { "number": 0, "status": "running" }, "cancellation_requested": true, "created_at": "2019-08-24T14:15:22Z", "error": {}, "expires_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "items_url": "string", "object": "operation", "progress": { "done": 0, "failed": 0, "total": 0 }, "result_url": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "type": "string" }}Reorder product content PUT
Sets the display order of the product's top-level content. The `ids` list may mix module IDs (`mod_`) and lesson IDs (`les_`), and must contain exactly the complete set of root modules and lessons that do not belong to any module. If the supplied set does not match, the request is rejected. Send the product's current `ETag` value in the `If-Match` header to avoid overwriting a newer version.
Publish a product POST
Starts an asynchronous publication of the product and all of its content. Publishing also publishes the product's copies in replicated accounts. Replicated products can be published. The response returns an operation. Track it through the URL in the `Location` header.