Menu

Rate this page:

Thanks for rating this page!

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

REST API: Connect Apps

The ConnectApps list resource shows all of the Connect Apps that you have created within your Twilio account. The instance resource shows information about the ConnectApp as well as the permissions the ConnectApp will request from authorizing users.

ConnectApp Instance Resource

Resource URI

/2010-04-01/Accounts/{AccountSid}/ConnectApps/{ConnectAppSid}

Resource Properties

Names in PHP format
accountSid
sid<AC> Not PII

The SID of the Account that created the ConnectApp resource.

authorizeRedirectUrl

The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.

companyName

The company name set for the Connect App.

deauthorizeCallbackMethod
http_method Not PII

The HTTP method we use to call deauthorize_callback_url.

deauthorizeCallbackUrl

The URL we call using the deauthorize_callback_method to de-authorize the Connect App.

description

The description of the Connect App.

friendlyName

The string that you assigned to describe the resource.

homepageUrl

The public URL where users can obtain more information about this Connect App.

permissions
enum:permission[] Not PII

The set of permissions that your ConnectApp requests.

sid
sid<CN> Not PII

The unique string that that we created to identify the ConnectApp resource.

uri
uri Not PII

The URI of the resource, relative to https://api.twilio.com.

HTTP GET

Get the properties of a Connect App.

Example
        
        
        
        

        HTTP POST

        Tries to update the Connect App's properties, and returns the updated resource representation if successful. The returned response is identical to that returned above when making a GET request.

        Optional Parameters

        You may specify one or more of the following parameters to update this Connect App's respective properties:

        Names in PHP format
        accountSid
        Required
        post sid<AC> Not PII

        The SID of the Account that created the ConnectApp resources to update.

        sid
        Required
        post sid<CN> Not PII

        The Twilio-provided string that uniquely identifies the ConnectApp resource to update.

        authorizeRedirectUrl
        Optional
        post url PII MTL: 30 DAYS

        The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.

        companyName
        Optional
        post string PII MTL: 30 DAYS

        The company name to set for the Connect App.

        deauthorizeCallbackMethod
        Optional
        post http_method Not PII

        The HTTP method to use when calling deauthorize_callback_url.

        deauthorizeCallbackUrl
        Optional
        post url PII MTL: 30 DAYS

        The URL to call using the deauthorize_callback_method to de-authorize the Connect App.

        description
        Optional
        post string PII MTL: 30 DAYS

        A description of the Connect App.

        friendlyName
        Optional
        post string PII MTL: 30 DAYS

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

        homepageUrl
        Optional
        post url PII MTL: 30 DAYS

        A public URL where users can obtain more information about this Connect App.

        permissions
        Optional
        post enum:permission[] Not PII

        A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: get-all and post-all.

        HTTP PUT

        Not supported.

        HTTP DELETE

        Not supported.

        ConnectApp List Resource

        Resource URI

        /2010-04-01/Accounts/{AccountSid}/ConnectApps
        

        HTTP GET

        Returns a list of Connect App resource representations, each representing a Connect App in your account. The list includes paging information.

        Example 1
              
              
              
              

              HTTP POST

              Not Supported.

              HTTP PUT

              Not Supported.

              HTTP DELETE

              Not Supported.

              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.