Skip to main content

API Validation Change to List Distribution Links

What are the changes?​

Qualtrics is committed to providing the best experience for our customers. As part of our strategy of improving the performance and reliability of our APIs, we are improving the validation for our List Distribution Links API call. To ensure uninterrupted service of the API calls in your brand, we encourage you to read this email carefully.

A Distribution is a communication (usually through email) to contacts to request for them to participate in a Survey. When creating a Distribution, the creator must specify the SurveyID which is being distributed. When a Distribution is created, it generates a DistributionId. These are in the format (EMD_<ID>). It also creates an individualized link for each contact who was sent the survey. The DistributionID can be used to List Distribution Links (the individualized links).

Presently, the API call to List Distribution Links endpoint requires a DistributionID and the SurveyID associated with that distribution. There is a bug in this endpoint where the endpoint accepts a SurveyID that does not match the provided DistributionID. Calling the endpoint this way results in links for the provided SurveyID, despite it not matching the Distribution.

Example: A user creates two surveys, with SurveyIDs SV_1 and SV_2. The user then calls the Generate Distribution Links endpoint, providing SV_1 as the survey id. This endpoint returns the distribution id EMD_1. The user then calls the List Distribution Links endpoint, providing EMD_1 as the DistributionID and SV_2 as the SurveyID. Note that the SurveyID here does not match the one provided when the Distribution was created. This results in links that lead to SV_2, despite the Distribution being created for SV_1.

Solution: Qualtrics is going to enforce that DistributionID and SurveyID must match on the GenerateDistributionLinks call.

What actions do you need to take?​

Please inspect any code paths that are calling this endpoint to ensure that the DistributionID was generated for the SurveyID passed to the call.

What if I have questions?​

If you have a question about the API validation changes, please visit the Public API documentation site. It’s also always worth checking the XM Community to see if any other users have the same question. If you’d rather speak to a specialist, our Support Team is always ready to assist. To contact them, please log into your Support Portal.