Marketplace Preview API will be discontinued in December 2024. Please complete all migrations to v1 before this date to ensure uninterrupted service.
A non-Preview version of the Marketplace API is now available. This new version, called "v1", provides increased reliability and is suitable for production environment use. You should upgrade your Marketplace applications to use v1 as soon as possible to take advantage of these improvements and upcoming feature releases.
This migration guide explains which API resources are affected and how to migrate Preview calls to v1.
The list below details which API resources must be migrated. Select the name of the resource to view its v1 API reference documentation.
https://preview.twilio.com/marketplace/AvailableAddOns
https://marketplace.twilio.com/v1/AvailableAddOns
https://preview.twilio.com/marketplace/AvailableAddOns/{{AddOnSid}}/Extensions
https://marketplace.twilio.com/v1/AvailableAddOns/{{AddOnSid}}/Extensions
https://preview.twilio.com/marketplace/InstalledAddOns
https://marketplace.twilio.com/v1/InstalledAddOns
https://preview.twilio.com/marketplace/InstalledAddOns/{{InstalledAddOnSid}}/Extensions
https://marketplace.twilio.com/v1/InstalledAddOns/{{InstalledAddOnSid}}/Extensions
https://preview.twilio.com/marketplace/Module/{{ModuleSid}}
https://marketplace.twilio.com/v1/Listing/{{ListingSid}}
https://preview.twilio.com/marketplace/InstalledAddOns/{{InstalledAddOnSid}}/Usage
https://marketplace.twilio.com/v1/InstalledAddOns/{{InstalledAddOnSid}}/Usage
The migration from Preview to v1 requires updating the base of API calls.
For calls made using curl, the base URL must be updated from https://preview.twilio.com/marketplace to https://marketplace.twilio.com/v1.
For calls made using the Twilio Helper Library, the method must be updated from preview to marketplace. The specific change needed varies by language used and is shown in the code sample below.
The only exception is the Listing resource (formerly known as Module resource). In this case, the resource Module has been renamed to Listing. To migrate these calls, both the API base and resource name must be updated. Refer to the Listing Resource documentation for more information and v1 examples.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listMarketplaceAvailableAddOn() {11const availableAddOns = await client.preview.marketplace.availableAddOns.list(12{ limit: 20 }13);1415availableAddOns.forEach((a) => console.log(a.sid));16}1718listMarketplaceAvailableAddOn();
To migrate to v1, update the sample shown above to the sample shown below:
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listAvailableAddOn() {11const availableAddOns = await client.marketplace.v1.availableAddOns.list({12limit: 20,13});1415availableAddOns.forEach((a) => console.log(a.sid));16}1718listAvailableAddOn();