Update a registration requirement

Updates the editable metadata, flags, attachments, or linked form for an existing requirement.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired
Requirement identifier

Request

This endpoint expects an object.
batch_idintegerRequired
registration_phase_idintegerOptional>=1
namestring or nullOptional
descriptionstring or nullOptional
requirement_detailsmap from strings to any or nullOptional
is_requiredboolean or nullOptional
is_editableboolean or nullOptional
is_publicboolean or nullOptional
relates_toenum or nullOptional
Allowed values:
sort_orderinteger or nullOptional
typeenum or nullOptional
Allowed values:
fileinteger or nullOptional
file_category_idinteger or nullOptional
document_templateinteger or nullOptional
form_idinteger or nullOptional

Response

Registration requirement updated
statusstringOptional
messagestringOptional
datamap from strings to anyOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error