Delete a module
/products/{product_id}/modules/{module_id}Moves the module to the trash, together with its submodules and lessons. Copies of the module in replicated accounts are also moved to the trash.
Restoring the module through the update operation does not restore those copies.
Replicated modules cannot be deleted. Attempts to delete them 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
Public ID of the product, prefixed with prd_.
Public ID of the module, prefixed with mod_.
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and 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 <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/products/string/modules/string"Update a module PATCH
Updates a module. Only the fields included in the request are changed. Changing `status` requires the `modules.publish` permission. Setting `target_product_id` moves the module to another product and requires the `modules.update` permission on that product; if the target product is not accessible with the current credentials, the API returns `404 Not Found`. Setting `deleted` to `false` restores a module from the trash. `position` is 1-based among the module's siblings, in the destination when the module is moved; a value greater than the number of siblings places the module at the end. A module moved to another group or product without `position` is placed at the end. Replicated modules accept only `status`. Requests that include any other field return the `replica_readonly` error code. Send the `ETag` from the retrieve operation in the `If-Match` header to avoid overwriting a newer version.
List module contents GET
Returns the direct contents of a module, meaning its submodules and the lessons placed directly in it, in display order. Items in the trash are not included. All entries are returned in a single response while preserving the standard collection response format.