Update a connect-app with the specified parameters

POST /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json

Twilio Connect apps

Update a connect-app with the specified parameters

Path parameters

  • AccountSid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • Sid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CN[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • AuthorizeRedirectUrl string(uri)

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

  • CompanyName string

    The company name to set for the Connect App.

  • DeauthorizeCallbackMethod string(http-method)

    The HTTP method to use when calling deauthorize_callback_url.

    Values are GET or POST.

  • DeauthorizeCallbackUrl string(uri)

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

  • Description string

    A description of the Connect App.

  • FriendlyName string

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

  • HomepageUrl string(uri)

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

  • Permissions array[string]

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

    Values are get-all or post-all.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the ConnectApp resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • authorize_redirect_url string(uri) | null

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

    • company_name string | null

      The company name set for the Connect App.

    • deauthorize_callback_method string(http-method) | null

      The HTTP method we use to call deauthorize_callback_url.

      Values are GET or POST.

    • deauthorize_callback_url string(uri) | null

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

    • description string | null

      The description of the Connect App.

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • homepage_url string(uri) | null

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

    • permissions array[string] | null

      The set of permissions that your ConnectApp requests.

      Values are get-all or post-all.

    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CN[0-9a-fA-F]{32}$.

    • uri string | null

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

POST /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json
curl \
 --request POST 'https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'CompanyName=company_name&Description=description&HomepageUrl=https%3A%2F%2Fexample.com&Permissions=get-all&FriendlyName=friendly_name&AuthorizeRedirectUrl=https%3A%2F%2Fexample.com&DeauthorizeCallbackUrl=https%3A%2F%2Fexample.com&DeauthorizeCallbackMethod=GET'
Request example
{"CompanyName"=>"company_name", "Description"=>"description", "HomepageUrl"=>"https://example.com", "Permissions"=>["get-all"], "FriendlyName"=>"friendly_name", "AuthorizeRedirectUrl"=>"https://example.com", "DeauthorizeCallbackUrl"=>"https://example.com", "DeauthorizeCallbackMethod"=>"GET"}
Response examples (200)
{
  "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "description": null,
  "permissions": [],
  "company_name": "Twilio",
  "homepage_url": "http://example.com/home",
  "friendly_name": "Connect app for deletion",
  "authorize_redirect_url": "http://example.com/redirect",
  "deauthorize_callback_url": "http://example.com/deauth",
  "deauthorize_callback_method": "GET"
}