Duplicate a module
/products/{product_id}/modules/{module_id}/copiesStarts an asynchronous operation that copies the module, including its contents, into the product given in target_product_id. Optionally, use parent_id to place the copy inside a group of the target product and name to rename it.
Requires the modules.create permission on the target product. Replicated modules cannot be copied, and modules cannot be copied into replicated products; both cases return the replica_readonly error code.
The Idempotency-Key header is required. Track progress through the returned operation; when it completes, the item result contains copy_id, the public ID of the new module.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
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
curl -X POST "https://example.com/products/string/modules/string/copies" \ -H "Content-Type: application/json" \ -d '{ "target_product_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 module contents PUT
Sets the display order of the submodules and lessons placed directly in the module. The `ids` array accepts both module public IDs (`mod_`) and lesson public IDs (`les_`) in the desired order. For each kind of item you send, the array must contain the complete set of items of that kind currently in the module. If the supplied set does not match, the API returns the `order_set_mismatch` error code and the existing order remains unchanged. To avoid overwriting concurrent changes, send the module `ETag` from the retrieve operation in the `If-Match` header.
Publish a module POST
Starts an asynchronous operation that publishes the module and everything nested in it. Copies of the module in replicated accounts are published as well. Replicated modules can also be published through this operation. The `Idempotency-Key` header is required. Track progress through the returned operation.