Create Multi-Country surveys

Owned by Claudio Baldi
Last updated: Aug 22, 2024
2 min read

Multi-Country survey allows to replicate the multi-country feature available via UI.

image-20240502-111732.png

 

This document explains how to create via API the Multi-Country survey via API and help the client to use any tool available in UI and API.

For more information about Multi-Country survey, visit this page: Helpjuice Multi-Country Survey

Context:

This API extends the create survey API and allow to connect multiple survey with an ID. This will transform a single project to a multi-country project.

Add this parameter, "mc_unique_id" in /buyers/v2/surveys in any survey that you want to make part of the Multi-country study. This will allow a UI user to manage the survey with the same UI experience

NOTE:

  • Make sure the Multi-Country feature is activate to your account

  • 2 surveys with the same localization cannot be added. E.g. (for localization we define the combination between Language and Country (en-US)

  • Once the Multi-Country survey is launched, the ID cannot be used again.

Request

API call:

GET <SERVER_BASE_URL>/buyers/v2/surveys

Parameters to add:

"mc_unique_id": "mc-id-1234"

Payload:

  • we can use the normal payload along with the mc_unique_id.

    • "mc_unique_id": "random-mc-id"

  • A validation is added so that multiple MC surveys cannot be added with the same localization.

Steps:

  1. Create the first MC survey localized in "en_US" with the mc_unique_id=test-mc-1234

  2. Create another MC survey localized in "es_US" (different localization) with the same mc_unique_id used in step 1.

  3. Create another MC survey localized in "en_CA" (different localization) with the same mc_unique_id used in step 1 and 2.

  4. Create further surveys following step 2 and 3.

  5. Launch all surveys individually using the status change API.