Skip to main content

Beta API Deprecation

What are the changes?​

We are deprecating our Beta APIs. When Qualtrics released these beta APIs, they were not intended for long term use. With the public release of the API/v3, all customers were expected to move from these beta APIs to the publicly released APIs.

If you are not aware of Qualtrics API development, you will be excited to learn that in the past few years we have grown our APIs to over 180 Public API endpoints and that the functionality that you rely on is already supported in the public version. Please be aware that there are some format changes to the call responses, so please check the Beta to V3 Migration Guide in order to help make changes to move to the new APIs.

The migration to our Public V3 APIs is critical for:

  • Improving security
  • Increasing availability
  • Enhancing the developer experience (easier to develop)
  • Add new functionality and capabilities

What action do I need to take?​

Please make sure you migrate all applications/services using Beta APIs to V3. All existing Beta functionality can be found with our new V3 API set.

Calls to any Beta APIs after March 31st, 2020, may result in failure to access the Qualtrics XM Platform

How can I tell if my calls are blocked?

After March 31st, calls, to the API/v1 endpoint will return the below message to indicate that the call needs to be migrated to the Public version:

{"meta":{"status":"Error","errorMessage":"https://api.qualtrics.com/docs/beta-to-v3-migration-guide","internalErrorCode":"ARH_18","requestId":"4d7abab4-2de9-4c50-bca4-3ae965bbfe07"},"result":null}

After May 31st, the error message will be removed and calls to the API/v1 endpoints will return HTTP status code 404 endpoint not found:

{"meta":{"httpStatus":"404 - Not Found","error":{"errorMessage":"The requested resource does not exist."}}}

What if I have questions?​

If you have a question about Beta API Deprecation, please check the Beta to V3 Migration Guide. 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.