Questionnaires

Attach an external questionnaire

Attaches a questionnaire that lives on another site — a Google Form, a Typeform, or your own hosted form. No template is involved and Check Cherry stores no answers; the questionnaire is a name and a link, and the guest is sent to that link to fill it out.

The response carries kind: "external" so clients know to open external_url directly rather than rendering the Check Cherry form builder. data.fieldGroups is empty on these records and pdf_url is null.

external_url may be sent without a scheme — forms.gle/abc is stored as https://forms.gle/abc. Set provider to identify your integration as the source; it is a free-form string and is left blank for links a business adds by hand.

Required permission: assigned_event_write or unassigned_event_write.

post/api/v1/questionnaires/create_external

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/questionnaires/create_external
  • Auth: none declared. Required headers: Api-Key

Headers

Api-Keystring required

Your Integration Key

Request body

event_idinteger required

The booking to attach the questionnaire to

titlestring required

Name shown to staff and customers

external_urlstring required

Where the questionnaire is hosted. Assumed to be https when no scheme is given.

providerstring

Optional name of the third party the questionnaire came from

Response

questionnaire attached

Changes

No recorded changes to this operation across all 2 revisions of this API.