Forms

Close a form

Stops accepting responses.

post/form/{form_id}/close/

Request

  • Base URL: https://hovercode.com/api/v2
  • URL: https://hovercode.com/api/v2/form/{form_id}/close/
  • Auth: API key in header Authorization

Path parameters

form_idstring uuid required

Form ID.

Response

OK

idstring uuid required
workspace_idstring uuid nullable
status'Draft' | 'Published' | 'Closed' | 'Deleted' required
logostring uri nullable
titlestring required
descriptionstring nullable
bg_colorstring

Hex color.

text_colorstring

Hex color.

button_colorstring

Hex color.

button_text_colorstring

Hex color.

thank_you_titlestring
thank_you_messagestring nullable
redirect_urlstring nullable
redirect_delayinteger
outcomesobject[] nullable
show_progressboolean
allow_multiple_submissionsboolean
show_powered_byboolean
notification_recipientsstring[] nullable
can_use_notificationsboolean
can_use_file_uploadsboolean
current_user_idstring nullable
current_user_email_verifiedboolean
current_user_emailstring nullable
shortlink_urlstring uri nullable
shortlink_domainstring nullable
shortlink_slugstring nullable
response_countinteger
has_unpublished_changesboolean
qr_code_svgstring nullable

Null until published.

qr_idstring uuid nullable
share_urlstring uri nullable

Public respondent link; null unless the form is Published.

dashboard_urlstring uri
can_remove_powered_byboolean
createdstring date-time
modifiedstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.