Implementing meta-tags

Implementing meta-tags depends on the channel you are using. Follow the appropriate guide based on your channel:

If using our API, see: Add External Recipients
If you have a website overlay survey, see: Adding meta-tags

As a general approach, meta-tags should take the following format:

"metatags": {
  "survey_question": "How likely are you to recommend %[question subject] to a friend or colleague?",
  "question_subject": "zenloop",
  "request_for_comment_all": "Tell us a bit more about why you chose %[score] as a score",
  "thank_you_note_all": "Thanks for your feedback!",
  "thank_you_link_text_all": "example text",
  "thank_you_link_url_all":  "https://www.example.com"
}

Or if you are looking to customize based on score (e.g. a different message for detractors vs promoters) - we have provided all of these options below:

📘
Metatag validation
When adding metatags by score type (e.g., thank_you_note_promoter, thank_you_note_passive, thank_you_note_detractor), ensure the following conditions are met for proper functionality:
Customization Based on Score
To enable meta-tags by score type:

Enable 'Customize based on score' Switch:

This switch must be enabled within the web interface during the design step of the survey.

Thank You Link Meta-Tags
To enable thank_you_link_url and thank_you_link_note meta-tags:

Enable 'Add a link' Switch:

This switch must be enabled within the web interface.

By following these steps, you ensure that the metatags are validated and work correctly within your survey setup.

"metatags": {
  "survey_question": "How likely are you to recommend %[question subject] to a friend or colleague?",
  "question_subject": "zenloop",
  "request_for_comment_promoter": "Tell us a bit more about why you chose %[score] as a score",
  "request_for_comment_passive": "Tell us a bit more about why you chose %[score] as a score",
  "request_for_comment_detractor": "Tell us a bit more about why you chose %[score] as a score",
  "thank_you_note_promoter": "Thanks for your feedback!",
  "thank_you_note_passive": "Thanks for your feedback!",
  "thank_you_note_detractor": "Thanks for your feedback!",
  "thank_you_link_text_promoter": "example text",
  "thank_you_link_text_passive": "example text",
  "thank_you_link_text_detractor": "example text",
  "thank_you_link_url_promoter": "https://www.example.com",
  "thank_you_link_url_passive": "https://www.example.com",
  "thank_you_link_url_detractor": "https://www.example.com"
}

API Example

Here is how meta-tags might look like when you are adding an external recipient using our API:

{
  "recipient": {
    "email": "[email protected]",
    "first_name": "test_first_name",
    "last_name": "test_last_name",
    "metatags": {
      "survey_question": "How likely are you to recommend %[question subject] to a friend or colleague?",
      "question_subject": "zenloop",
      "request_for_comment_all": "Tell us a bit more about why you chose %[score] as a score",
      "thank_you_note_all": "Thanks for your feedback!",
      "thank_you_link_text_all": "example text",
      "thank_you_link_url_all": "https://www.example.com"
    },
    "properties": [
      {
        "name": "country",
        "value": "germany"
      },
      {
        "name": "gender",
        "value": "male"
      }
    ]
  }
}

📘Metatag validation

API Example

📘
Metatag validation