Create a study in a folder.

Always required

Schema fields

Provide exactly one of these pairs. Do not mix them:

• schemaId with schemaFields (preferred). Keys in schemaFields must be field system names or field API IDs, not display names.
• The deprecated studySchemaId with the deprecated tags. Keys in tags must be field display names or field API IDs.

List schemas with the study-schema list endpoint. See the request example for supported field value shapes.

name

• Required when the study schema has no naming template.
• Must be omitted when the schema has a naming template (the server generates the name).

designEntryId

• Required when the schema's studyType is CUSTOM.
• Must be omitted for every other studyType.
• Read studyType from the study-schema get-by-ID endpoint. List entries with the entry list endpoint. A design entry can belong to only one study.

displayId

Behavior depends on the schema's idGenerationMode, which you can read from the study-schema get-by-ID endpoint:

• AUTO_GENERATED_FROM_PREFIX: omit displayId. The server assigns an ID from the schema prefix. Providing displayId fails validation.
• MANUAL: you may provide displayId (must be unique within the tenant), or omit it to have the server generate one.

authorIds

• Omit to default authors to the creator.
• Provide an array of user or app IDs to set a specific author list. List users with the user list endpoint.
• Pass an empty array to create the study without authors.
• Do not pass null.

The request example includes name, designEntryId, and displayId together for a Custom study on a MANUAL schema with no naming template. Other schema configurations require a different subset of these fields.