✉️ Add Invitations

This guide explains how to add invitations to a quest using the Questback Public API.
See the Add/Send Invitations endpoints under the Invitations section:
👉 API Reference: Invitations

🌐 Language SupportCopied!

Invitations can be sent in any language that is enabled for the quest.

If the translation for a selected language is missing, the default language will be used.
If a specified language is not supported by the quest, a 400 Bad Request response is returned.

Example:

"languageCode": "en-GB"

📇 Contact InformationCopied!

Invitations can be sent by email or SMS, depending on what’s enabled for your account or quest.
Sending SMS may incur additional costs.

📧 EmailCopied!

To send an email invitation, provide a valid email address in the respondent object.

If the email is invalid, a 400 Bad Request is returned.

Example:

"respondent": [
  { "EMAIL": "test@questback.com" }
]

📱 SMSCopied!

To send SMS invitations, provide a valid phone number using the format +<countrycode><number>.
(E.g., +4712345678)

Invalid numbers will result in a 400 Bad Request response.

Example:

"respondent": [
  { "SMS": "+4712345678" }
]

🧾 Respondent DataCopied!

You can include respondent-specific data to personalize invitations or the survey experience.

All data fields must be predefined on the quest before sending the invitation.
Make sure the respondent data fields are added in ESS under Distribution read more
You must use the ID (GUID) of the respondent data field, not the name.
It is possible to fetch setup for the respondent data fields using the API

Example:

"respondentData": {
  "0196a9ba-1aea-739a-8594-8d3ff1867ef7": "John Doe",
  "0196a9ba-1aea-7071-9779-618832059e8": "Sales"
}

⏱️ Processing Time for InvitationsCopied!

When you add invitations via the API, they are queued for processing — they are not immediately visible in the system.

What to Expect:Copied!

Invitations are queued and imported as soon as system resources allow.
Import speed depends on system load and the size of the batch.
Once processed, the invitations will be available for sending.

📦 Tracking Import StatusCopied!

After adding a batch, the API will return a batchId. You can use this to check the import status:

🔗 Check Invitation Import Status

Avoid resubmitting the same batch — all valid invitations will be processed automatically.

🆘 SupportCopied!

If you experience unusual delays or persistent issues with invitation processing, contact our
📬 support team for assistance.