Upgrading to API v3: A Guide for SurveySparrow Users

As a part of our commitment to delivering a secure and seamless experience, SurveySparrow is transitioning from API v1 to the API v3. This upgrade brings enhanced security, improved performance, and expanded functionality to our platform. The API v1 will be deprecated as of December 31, 2024. We'll guide you through the process of upgrading from API v1 to v3, ensuring a smooth transition for your integrations and applications. 

Why upgrade to API v3?

The transition to API v3 offers several key benefits:

1. Improved Performance: API v3 offers enhanced performance and efficiency, resulting in faster response times and better reliability.
2. Simplified Integration: For example, with API v3, you no longer need to manage multiple APIs for different share channels. This simplifies your integration process and reduces the complexity of your codebase.
3. Future-Proofing: As SurveySparrow continues to evolve and introduce new features, API v3 ensures that your integration remains compatible and future-proof.
4. Enhanced Flexibility: API v3 provides greater flexibility allowing you to customize and optimize your integration according to your specific requirements.

Migration Process

Follow these steps to migrate from API v1 to v3:

1. Update API Endpoint:
   Modify your existing API calls to use the new API v3 endpoints. You could refer the article for more information: https://developers.surveysparrow.com/rest-apis
2. Adjust Parameters:
   Update any parameters or payload data in your API calls to align with the format and requirements of API v3. Refer to the API v3 documentation for details on parameter changes and payload structure.
3. Test and Validate:
   After updating your API calls, thoroughly test and validate the functionality to ensure that everything is working as expected. Perform testing across different share channel types to identify any potential issues or discrepancies.
4. Optimize Integration:
   Take advantage of the streamlined nature of API v3 to optimize your integration code. Eliminate redundant code and unnecessary API calls to improve performance and maintainability.
5. Seek Assistance:
   If you encounter any challenges or require assistance during the transition process, our dedicated support team is here to help. Don't hesitate to reach out to us for personalized assistance and guidance.
6. Note: In one investigation, global-level throttling configured on the account limited email sending capacity and contributed to contacts not receiving survey invitations.
7. Common migration pitfall (Email Share + Salesforce): Some Salesforce integrations (Apex classes or older AppExchange versions) were built on deprecated API v1 and only support Email Share v1. If an Email Share channel is migrated/updated to Email Share v2, it can become incompatible with API v1 and cause survey email triggers to stop functioning (no emails sent / sharp drop in responses). In such cases, the resolution options shared were: (1) update the Salesforce integration from API v1 to API v3, or (2) move the Email Share setup back to v1 by creating a new email channel and updating the Channel ID used in Salesforce.

Timeline and Deadline

The deprecation of the API v1 will be effective from December 31, 2024. We strongly recommend completing the migration to API v3 before this date to avoid any disruption in your operations. Remember to allocate sufficient time for testing and validation to ensure a smooth transition.

Upgrading to API v3 is a crucial step towards ensuring the security, reliability, and functionality of your SurveySparrow integrations and applications. By following the steps outlined in this guide and leveraging our resources and support, you can seamlessly transition to API v3 and unlock the full potential of our platform.

Thank you for your cooperation and commitment to staying updated with the latest advancements in SurveySparrow. Should you have any questions or require further assistance, don't hesitate to reach out to our support team.