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.
Plugin properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the Flex Plugin resource. |
account_sid
|
The SID of the Account that created the Flex Plugin resource and owns this resource. |
unique_name
|
The name that uniquely identifies this Flex Plugin resource. |
friendly_name
|
The friendly name this Flex Plugin resource. |
description
|
A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long |
archived
|
Whether the Flex Plugin is archived. The default value is false. |
date_created
|
The date and time in GMT-7 when the Flex Plugin was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT-7 when the Flex Plugin was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the Flex Plugin resource. |
links
|
|
Create a Plugin resource
https://flex-api.twilio.com/v1/PluginService/Plugins
Parameters
| Parameters in REST API format | |
|---|---|
unique_name
Required
|
The Flex Plugin's unique name. |
friendly_name
Optional
|
The Flex Plugin's friendly name. |
description
Optional
|
A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long |
flex_metadata
Header
|
The Flex-Metadata HTTP request header |
Example 1
Fetch a Plugin resource
https://flex-api.twilio.com/v1/PluginService/Plugins/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flex Plugin resource to fetch. |
flex_metadata
Header
|
The Flex-Metadata HTTP request header |
Example 1
Read multiple Plugin resources
https://flex-api.twilio.com/v1/PluginService/Plugins
Parameters
| Parameters in REST API format | |
|---|---|
flex_metadata
Header
|
The Flex-Metadata HTTP request header |
Example 1
Update a Plugin resource
https://flex-api.twilio.com/v1/PluginService/Plugins/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flex Plugin resource to update. |
friendly_name
Optional
|
The Flex Plugin's friendly name. |
description
Optional
|
A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long |
flex_metadata
Header
|
The Flex-Metadata HTTP request header |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
