Set form availability

Open or close a form for responses. The form must have been published before you can open it.


PATCH/api/v1/forms/{formId}/availability

Authorization

Authorization required string · header
Send Bearer <token> with an account API key that has the forms:write scope.

Path parameters

formId required string
Form ID. See FormModel.

Request body

application/json

Send only the active property.

active required boolean
Set to true to accept responses or false to close the form.

Response

200 · application/json

Source model: FormModel.

FieldTypeDescription
idstringID returned by the operation.
activebooleanWhether the form accepts responses.