Menu

Expand
Rate this page:

Plugin Version Resource

A Plugin Version contains all the information about a particular version of a Plugin. Some notable fields include the URL to the plugin package, the version number and what plugin is it the version of.

Providing a URL to the built package in the plugin version provides you the flexibility of hosting your package in the software of your choice.

PluginVersion properties

Resource Properties in REST API format
sid
sid<FV> Not PII

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

plugin_sid
sid<FP> Not PII

The SID of the Flex Plugin resource this Flex Plugin Version belongs to.

account_sid
sid<AC> Not PII

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

version
string Not PII

The unique version of this Flex Plugin Version.

plugin_url

The URL of where the Flex Plugin Version JavaScript bundle is hosted on.

changelog

A changelog that describes the changes this Flex Plugin Version brings.

private
boolean Not PII

Whether to inject credentials while accessing this Plugin Version. The default value is false.

archived
boolean Not PII

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

date_created
date_time<iso8601> Not PII

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

url
url Not PII

The absolute URL of the Flex Plugin Version resource.

Create a PluginVersion resource

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

The SID of the Flex Plugin the resource to belongs to.

version
Required
post string Not PII

The Flex Plugin Version's version.

plugin_url
Required
post url PII MTL: 30 DAYS

The URL of the Flex Plugin Version bundle

changelog
Optional
post string PII MTL: 30 DAYS

The changelog of the Flex Plugin Version.

private
Optional
post boolean Not PII

Whether this Flex Plugin Version requires authorization.

flex_metadata
Header
post string Not PII

The Flex-Metadata HTTP request header

Example 1
        
        
        
        

        Fetch a PluginVersion resource

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

        The SID of the Flex Plugin the resource to belongs to.

        sid
        Path
        get sid_like<FV> Not PII

        The SID of the Flex Plugin Version resource to fetch.

        flex_metadata
        Header
        get string Not PII

        The Flex-Metadata HTTP request header

        Example 1
              
              
              
              

              Read multiple PluginVersion resources

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

              The SID of the Flex Plugin the resource to belongs to.

              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