Menu

Expand
Rate this page:

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

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

account_sid
sid<AC> Not PII

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
boolean Not PII

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

date_created
date_time<iso8601> Not PII

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

date_updated
date_time<iso8601> Not PII

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

url
url Not PII

The absolute URL of the Flex Plugin resource.

links
uri_map Not PII

Create a Plugin resource

post
https://flex-api.twilio.com/v1/PluginService/Plugins
Parameters
Parameters in REST API format
unique_name
Required
post string PII MTL: 30 DAYS

The Flex Plugin's unique name.

friendly_name
Optional
post string PII MTL: 30 DAYS

The Flex Plugin's friendly name.

description
Optional
post string PII MTL: 30 DAYS

A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long

flex_metadata
Header
post string Not PII

The Flex-Metadata HTTP request header

Example 1
        
        
        

        Fetch a Plugin resource

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

        The SID of the Flex Plugin resource to fetch.

        flex_metadata
        Header
        get string Not PII

        The Flex-Metadata HTTP request header

        Example 1
              
              
              

              Read multiple Plugin resources

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

              The Flex-Metadata HTTP request header

              Example 1
                    
                    
                    

                    Update a Plugin resource

                    post
                    https://flex-api.twilio.com/v1/PluginService/Plugins/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    post sid_like<FP> Not PII

                    The SID of the Flex Plugin resource to update.

                    friendly_name
                    Optional
                    post string PII MTL: 30 DAYS

                    The Flex Plugin's friendly name.

                    description
                    Optional
                    post string PII MTL: 30 DAYS

                    A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long

                    flex_metadata
                    Header
                    post 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 by visiting our Twilio Community forums or 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