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

account_sid
sid<AC> Not PII

The unique id of the Account that created this ConnectApp.

authorize_redirect_url

The URL the user's browser will redirect to after Twilio authenticates the user and obtains authorization for this Connect App.

company_name

The company name set for this Connect App.

deauthorize_callback_method
http_method Not PII

The HTTP method to be used when making a request to the DeauthorizeCallbackUrl.

deauthorize_callback_url

The URL to which Twilio will send a request when a user de-authorizes this Connect App.

description

A more detailed human readable description of the Connect App.

friendly_name

A human readable name for the Connect App.

homepage_url

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 id of this Connect App.

uri
uri Not PII

The URI for this resource, relative to https://api.twilio.com.

HTTP GET

Get the properties of a Connect App.

Example
Loading Code Sample...
      
      
      
      

      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:

      AuthorizeRedirectUrl
      Optional
      post url Not PII

      The URL the user's browser will redirect to after Twilio authenticates the user and obtains authorization for this Connect App.

      CompanyName
      Optional
      post string Not PII

      The company name set for this Connect App.

      DeauthorizeCallbackMethod
      Optional
      post http_method Not PII

      The HTTP method to be used when making a request to the DeauthorizeCallbackUrl. Either GET or POST.

      DeauthorizeCallbackUrl
      Optional
      post url Not PII

      The URL to which Twilio will send a request when a user de-authorizes this Connect App.

      Description
      Optional
      post string Not PII

      A more detailed human readable description of the Connect App.

      FriendlyName
      Optional
      post string Not PII

      A human readable description of the Connect App, with maximum length 64 characters.

      HomepageUrl
      Optional
      post url Not PII

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

      Permissions
      Optional
      post enum:permission[] Not PII

      A comma-separated list of permssions you will request from users of this ConnectApp. Valid permssions are get-all or 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
      Loading Code Sample...
          
          
          
          

          HTTP POST

          Not Supported.

          HTTP PUT

          Not Supported.

          HTTP DELETE

          Not Supported.

          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.

          Loading Code Sample...