Objects

Update a form

Updates a form's title or description. Only provided fields are changed. To manage questions, use the form field endpoints.

patch/forms/{id}

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/forms/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Form ID (frm_ prefix)

Request body

titlestring

Form title

descriptionstring nullable

Form description shown to respondents

Response

OK

idstring required

Form ID (frm_ prefix)

titlestring required

Form title

descriptionstring nullable required

Form description shown to respondents

entitystring nullable required

CRM entity this form is associated with (e.g. leads, deals), if any

submissionCountnumber required

Total number of submissions received

createdByIdstring nullable required

ID of the user who created the form (usr_ prefix)

createdByNamestring nullable required

Name of the user who created the form

createdAtstring date-time required

When the form was created

updatedAtstring date-time nullable required

When the form was last updated

Changes

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