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
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the ConnectApp resource. |
authorize_redirect_url
|
The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App. |
company_name
|
The company name set for the Connect App. |
deauthorize_callback_method
|
The HTTP method we use to call |
deauthorize_callback_url
|
The URL we call using the |
description
|
The description of the Connect App. |
friendly_name
|
The string that you assigned to describe the resource. |
homepage_url
|
The public URL where users can obtain more information about this Connect App. |
permissions
|
The set of permissions that your ConnectApp requests. |
sid
|
The unique string that that we created to identify the ConnectApp resource. |
uri
|
The URI of the resource, relative to |
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:
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
The SID of the Account that created the ConnectApp resources to update. |
sid
Path
|
The Twilio-provided string that uniquely identifies the ConnectApp resource to update. |
authorize_redirect_url
Optional
|
The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App. |
company_name
Optional
|
The company name to set for the Connect App. |
deauthorize_callback_method
Optional
|
The HTTP method to use when calling |
deauthorize_callback_url
Optional
|
The URL to call using the |
description
Optional
|
A description of the Connect App. |
friendly_name
Optional
|
A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
homepage_url
Optional
|
A public URL where users can obtain more information about this Connect App. |
permissions
Optional
|
A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: |
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
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 Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
