Menu

Expand
Rate this page:

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
sid<FJ> Not PII

The unique string that we created to identify the Flex Plugin Configuration resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Flex Plugin Configuration resource and owns this resource.

name
string Not PII

The name of this Flex Plugin Configuration.

description

The description of the Flex Plugin Configuration resource.

archived
boolean Not PII

Whether the Flex Plugin Configuration is archived. The default value is false.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the Flex Plugin Configuration was created specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Flex Plugin Configuration resource.

links
uri_map Not PII

Create a PluginConfiguration resource

post
https://flex-api.twilio.com/v1/PluginService/Configurations
Parameters
Parameters in REST API format
name
Required
post string Not PII

The Flex Plugin Configuration's name.

plugins
Optional
post object[] Not PII

A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version.

description
Optional
post string PII MTL: 30 DAYS

The Flex Plugin Configuration's description.

flex_metadata
Header
post string Not PII

The Flex-Metadata HTTP request header

Example 1
        
        
        
        
        Example 2
              
              
              
              

              Fetch a PluginConfiguration resource

              get
              https://flex-api.twilio.com/v1/PluginService/Configurations/{Sid}
              Parameters
              Parameters in REST API format
              sid
              Path
              get sid<FJ> Not PII

              The SID of the Flex Plugin Configuration resource to fetch.

              flex_metadata
              Header
              get string Not PII

              The Flex-Metadata HTTP request header

              Example 1
                    
                    
                    
                    

                    Read multiple PluginConfiguration resources

                    get
                    https://flex-api.twilio.com/v1/PluginService/Configurations
                    Parameters
                    Parameters in REST API format
                    flex_metadata
                    Header
                    get string Not PII

                    The Flex-Metadata HTTP request header

                    Example 1
                          
                          
                          
                          
                          Rate this page:

                          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 browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

                                We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more