Set field definitions on a study schema
Asynchronously set field definitions on a study schema. Requires administrator permission on the schema, Studies to be enabled, and updates to be allowed for the schema’s study type.
Include every existing field, including archived fields, in the desired order. Provide a field ID to update an existing field; omit the ID to create a new field. Omitted update attributes retain their existing values. To archive a field, set archived to true and provide archiveReason. Omitting a field does not delete it and causes validation to fail. Configured schema field limits apply.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Set to true to access beta operations via /api/v3.
Request
The complete field list in the desired order, including archived fields. Include an ID for each existing field and omit the ID for new fields. Omitted update attributes retain their existing values. To archive an existing field, set archived to true and provide archiveReason. All existing fields must be included; omission is not deletion. Configured schema field limits apply.