Get Started

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

Property Description
Sid The unique id of this Connect App.
DateCreated The date that this resource was created, given as GMT RFC 2822 format.
DateUpdated The date that this resource was last updated, given as GMT RFC 2822 format.
AccountSid The unique id of the Account that created this ConnectApp.
Permissions The set of permissions that your ConnectApp requests.
FriendlyName A human readable name for the Connect App.
Description A more detailed human readable description of the Connect App.
CompanyName The company name set for this Connect App.
HomepageUrl The public URL where users can obtain more information about this Connect App.
AuthorizeRedirectUrl The URL the user's browser will redirect to after Twilio authenticates the user and obtains authorization for this Connect App.
DeauthorizeCallbackUrl The URL to which Twilio will send a request when a user de-authorizes this Connect App.
DeauthorizeCallbackMethod The HTTP method to be used when making a request to the DeauthorizeCallbackUrl.
Uri The URI for this 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:

Parameter Description
FriendlyName A human readable description of the Connect App, with maximum length 64 characters.
AuthorizeRedirectUrl The URL the user's browser will redirect to after Twilio authenticates the user and obtains authorization for this Connect App.
DeauthorizeCallbackUrl The URL to which Twilio will send a request when a user de-authorizes this Connect App.
DeauthorizeCallbackMethod The HTTP method to be used when making a request to the DeauthorizeCallbackUrl. Either GET or POST.
Permissions A comma-separated list of permssions you will request from users of this ConnectApp. Valid permssions are get-all or post-all.
Description A more detailed human readable description of the Connect App.
CompanyName The company name for this Connect App.
HomepageUrl The public URL where users can obtain more information about this Connect App.

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.