Plugin Configuration Resource
Configurations contain a snapshot of your contact center's customizations so that it can be audited or rolled back. It is a package of your plugin versions that you bundle together for a release. Configurations contain Plugin Version SIDs and are defined as a list of JSON strings. For example:
[{"plugin_version": "FV00000000000000000000000000000000"}, {"plugin_version": "FV00000000000000000000000000000001"}]
Configurations are immutable; in order to update your contact center's Configuration, you must create a new Configuration.
PluginConfiguration properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the Flex Plugin Configuration resource. |
account_sid
|
The SID of the Account that created the Flex Plugin Configuration resource and owns this resource. |
name
|
The name of this Flex Plugin Configuration. |
description
|
The description of the Flex Plugin Configuration resource. |
archived
|
Whether the Flex Plugin Configuration is archived. The default value is false. |
date_created
|
The date and time in GMT when the Flex Plugin Configuration was created specified in ISO 8601 format. |
url
|
The absolute URL of the Flex Plugin Configuration resource. |
links
|
|
Create a PluginConfiguration resource
https://flex-api.twilio.com/v1/PluginService/Configurations
Parameters
| Parameters in REST API format | |
|---|---|
name
Required
|
The Flex Plugin Configuration's name. |
plugins
Optional
|
A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version. |
description
Optional
|
The Flex Plugin Configuration's description. |
flex_metadata
Header
|
The Flex-Metadata HTTP request header |
Example 1
Example 2
Fetch a PluginConfiguration resource
https://flex-api.twilio.com/v1/PluginService/Configurations/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flex Plugin Configuration resource to fetch. |
flex_metadata
Header
|
The Flex-Metadata HTTP request header |
Example 1
Read multiple PluginConfiguration resources
https://flex-api.twilio.com/v1/PluginService/Configurations
Parameters
| Parameters in REST API format | |
|---|---|
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.
