Create a Text Highlighter Question via the API

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

Looking to create an Text Highlighter question via the API? You'll need use the surveyquestion and surveyoption endpoints to fully build out the question.

1. Create the Text Highlighter Question

Start by creating the Text Highlighter question with the below endpoint.

Rest method: PUT

URL: https://restapi.surveygizmo.com/v5/survey/123456/surveypage/{id}/surveyquestion

Required fields: type=texthighlighter

Other non-required but necessary fields: title={This%20is%20my%20question%20text}, properties[messages][th_content][English]={This%20is%20the%20text%20to%20highlight}

2. Create your Text Highlighter Options

Now you're ready to add your Text Highlighter options via the below endpoint.

Rest method: PUT

URL: https://restapi.surveygizmo.com/v5/survey/123456/surveypage{id}/surveyquestion/{id}/surveyoption

Required fields: title={Option Title}, value={Reporting Value}

Other non-required but necessary fields: properties[heatmap-color]={f06486} (this is a hex code without the #)