Plugin Resource
A Plugin is a resource that contains information about a given plugin, like its name, description, and the account that owns the plugin.
While the Plugin Version Resource contains information on the actual source code for a deployed Plugin, the Plugin Resource serves as an identifier for the Plugin itself. For example, you might have a CRM plugin. You can use the Plugin Resource to describe the plugin itself, and then a series of Plugin Versions to reference the source code of your various iterations of the Plugin.
Property nameTypePIIDescription
The unique string that we created to identify the Flex Plugin resource.
Pattern: ^FP[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the Account that created the Flex Plugin resource and owns this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The name that uniquely identifies this Flex Plugin resource.
The friendly name this Flex Plugin resource.
A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
Whether the Flex Plugin is archived. The default value is false.
date_createdstring<date-time>
date_updatedstring<date-time>
The absolute URL of the Flex Plugin resource.
POST https://flex.twilio.com/v1/PluginService/Plugins
Property nameTypeRequiredPIIDescription
The Flex Plugin's unique name.
FriendlyNamestringOptional The Flex Plugin's friendly name.
DescriptionstringOptional A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function createPlugin() {
_18 const plugin = await client.flexApi.v1.plugins.create({
_18 uniqueName: "UniqueName",
_18 console.log(plugin.sid);
_14 "sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "unique_name": "UniqueName",
_14 "friendly_name": "friendly name",
_14 "description": "description",
_14 "date_created": "2020-01-10T20:00:00Z",
_14 "date_updated": "2020-01-10T20:00:00Z",
_14 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions"
GET https://flex.twilio.com/v1/PluginService/Plugins/{Sid}
Property nameTypeRequiredPIIDescription
The SID of the Flex Plugin resource to fetch.
_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16async function fetchPlugin() {
_16 const plugin = await client.flexApi.v1.plugins("Sid").fetch();
_16 console.log(plugin.sid);
_14 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "unique_name": "unique-name",
_14 "friendly_name": "friendly name",
_14 "description": "description",
_14 "date_created": "2020-01-10T20:00:00Z",
_14 "date_updated": "2020-01-10T20:00:00Z",
_14 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions"
GET https://flex.twilio.com/v1/PluginService/Plugins
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1
Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16async function listPlugin() {
_16 const plugins = await client.flexApi.v1.plugins.list({ limit: 20 });
_16 plugins.forEach((p) => console.log(p.sid));
_12 "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0",
_12 "previous_page_url": null,
_12 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0",
_12 "next_page_url": null,
POST https://flex.twilio.com/v1/PluginService/Plugins/{Sid}
Property nameTypeRequiredPIIDescription
The SID of the Flex Plugin resource to update.
Property nameTypeRequiredPIIDescription
FriendlyNamestringOptional The Flex Plugin's friendly name.
DescriptionstringOptional A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function updatePlugin() {
_18 const plugin = await client.flexApi.v1
_18 .update({ friendlyName: "FriendlyName" });
_18 console.log(plugin.sid);
_14 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "unique_name": "unique-name",
_14 "friendly_name": "FriendlyName",
_14 "description": "description update",
_14 "date_created": "2020-01-10T20:00:00Z",
_14 "date_updated": "2020-01-10T20:00:00Z",
_14 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions"