Generate a cleanroom from a template

Creates a new cleanroom from a template in one call (UI "Generate Clean Room"). The generated cleanroom includes questions, flows, question permissions, Habu Intelligence dashboards (when the template has HI enabled), and value constraints. Flows and intelligence are applied asynchronously. When questionIds is omitted, all cloneable template question IDs are included. When questionPermissions is omitted, template default question permissions are applied. Optional constraintOverrides customize value constraints on the target; otherwise source constraints are cloned as-is. Only cleanRoom.name is required for a full generate.

Path Params
string
required

Source template cleanroom ID to generate from

Body Params

Single-call request to generate a cleanroom from a template with questions, flows, permissions, intelligence dashboards, and value constraints. Omit questionIds and questionPermissions to use all cloneable questions and template default permissions (same as the UI Generate Clean Room defaults). Flows and Habu Intelligence are included asynchronously by unhygienix/pegleg. Optional GET .../generate can be used first to inspect template assets before generating.

cleanRoom
object
required

Generated cleanroom details. Only name is required; description, endAt, parameters (for example ENABLE_HABU_INTELLIGENCE, CLOUD, REGION), privacy settings, and other fields are optional overrides. Type and startAt are inherited from the source template.

boolean
Defaults to true

true keeps the generated cleanroom coupled to the template (parent lineage); false decouples it (independent copy). Matches the UI "Decouple From Template" toggle inverted (decouple checked => lineage false).

string

CloneCleanRoom.accountID. Optional; when omitted, unused is sent.

questionIds
array of strings

Optional subset of template cleanroom-question IDs to include. When omitted or empty, all cloneable question IDs from the template are included automatically.

questionIds
string

Optional JSON string of runtime-parameter value-constraint overrides for the generated cleanroom. When omitted, source template value constraints are cloned as-is.

questionPermissions
array of objects

Optional question permissions for the generated cleanroom. When omitted or empty, template default question permissions are applied automatically.

questionPermissions
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json