Follow changes to the Prequel API and manage versions in your requests.
Prequel releases API versions, each identified by a date, to introduce backwards-incompatible changes that might affect existing integrations. The first new version of the Prequel API is 2023-12-01.
Some API changes shouldn’t break existing integrations. For example, we don’t consider additive changes (new endpoints, new optional parameters, new enum values, etc) to be breaking changes. When this type of change is introduced, Prequel will add it to all active versions.
Current versions
The available versions of the Prequel API are 2023-12-01 and 2022-01-01 ( 2022-01-01 is the base version and the current default). We recommend new users build against 2023-12-01. Both versions are actively maintained. If you are an existing developer, we will reach out to you directly regarding migration plans and timelines.
What's new in 2023-12-01
2023-12-01Updates to the destination object
We renamed fields on destinations where the database vendor uses proprietary terminology. For example, the field username on Amazon Athena has changed to workgroup.
We've added enum values and reorganized nested objects in order to clarify conditional dependencies between fields. We may update other endpoints similarly based on feedback.
Updates to Magic Link creation
Magic Links no longer accept the id_in_provider_system or products fields in the POST object. Instead, it only accepts recipient_id to associate the subsequent destination with an recipient. If you are creating a Magic Link for a new recipient, you'll have to create the recipient resource first and pass the id of that object to the Magic Link creation endpoint.
Update to Recipient creation
Recipients no longer accept the schema field in the POST object. Users should use the id_in_provider_system field to denote the tenant ID for their intended recipient, regardless of whether your source is schema or row-tenanted.
Pagination
List endpoints support pagination in 2023-12-01.
Status code when testing connection
The destination test-connection endpoints return a top-level status code of success in 2023-12-01 if the request was well-formed, regardless of whether the test passed.
Upgrading your version
You can set the x-prequel-api-version header to specify the API version per-request.
curl --request GET \
--url https://api.prequel.co/destinations \
--header 'X-PREQUEL-API-VERSION: ‘2023-12-01`
If no version is specified, the current base (2022-01-01) will be used.
Prequel SDKs
The Prequel SDKs use the base version.