Developers
Products19

Reorder product content

PUT/products/{product_id}/content/order

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.

Discover the required set through GET /products/{product_id}/content, following every cursor page without narrowing filters such as status, kind or search. A fully paginated list is still limited by credential visibility; verify that the credential can read the entire required set before reordering. On order_set_mismatch, re-read the set and check scope and visibility instead of blindly retrying stale IDs.

The response returns the complete reordered collection in a single response, including collections larger than 200 items. This reorder response is not paginated.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

Header Parameters

Idempotency-Key?string

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.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

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.

Lengthlength <= 64

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

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/products/string/content/order" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "string"    ]  }'
{  "data": [    {      "id": "string",      "kind": "module",      "name": "string",      "object": "content_entry",      "position": 0,      "status": "published"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

List product content GET

Lists the top-level content of a product: its root modules and the lessons that do not belong to any module, in their display order, using cursor-based pagination.

Copy a product POST

Starts 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.