github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsConnectAppsApi.md (about)

     1  # AccountsConnectAppsApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteConnectApp**](AccountsConnectAppsApi.md#DeleteConnectApp) | **Delete** /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json | 
     8  [**FetchConnectApp**](AccountsConnectAppsApi.md#FetchConnectApp) | **Get** /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json | 
     9  [**ListConnectApp**](AccountsConnectAppsApi.md#ListConnectApp) | **Get** /2010-04-01/Accounts/{AccountSid}/ConnectApps.json | 
    10  [**UpdateConnectApp**](AccountsConnectAppsApi.md#UpdateConnectApp) | **Post** /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json | 
    11  
    12  
    13  
    14  ## DeleteConnectApp
    15  
    16  > DeleteConnectApp(ctx, Sidoptional)
    17  
    18  
    19  
    20  Delete an instance of a connect-app
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **Sid** | **string** | The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a DeleteConnectAppParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource to fetch.
    38  
    39  ### Return type
    40  
    41   (empty response body)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: Not defined
    50  - **Accept**: Not defined
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## FetchConnectApp
    58  
    59  > ApiV2010ConnectApp FetchConnectApp(ctx, Sidoptional)
    60  
    61  
    62  
    63  Fetch an instance of a connect-app
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **Sid** | **string** | The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a FetchConnectAppParams struct
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource to fetch.
    81  
    82  ### Return type
    83  
    84  [**ApiV2010ConnectApp**](ApiV2010ConnectApp.md)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: Not defined
    93  - **Accept**: application/json
    94  
    95  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    96  [[Back to Model list]](../README.md#documentation-for-models)
    97  [[Back to README]](../README.md)
    98  
    99  
   100  ## ListConnectApp
   101  
   102  > []ApiV2010ConnectApp ListConnectApp(ctx, optional)
   103  
   104  
   105  
   106  Retrieve a list of connect-apps belonging to the account used to make the request
   107  
   108  ### Path Parameters
   109  
   110  This endpoint does not need any path parameter.
   111  
   112  ### Other Parameters
   113  
   114  Other parameters are passed through a pointer to a ListConnectAppParams struct
   115  
   116  
   117  Name | Type | Description
   118  ------------- | ------------- | -------------
   119  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to read.
   120  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   121  **Limit** | **int** | Max number of records to return.
   122  
   123  ### Return type
   124  
   125  [**[]ApiV2010ConnectApp**](ApiV2010ConnectApp.md)
   126  
   127  ### Authorization
   128  
   129  [accountSid_authToken](../README.md#accountSid_authToken)
   130  
   131  ### HTTP request headers
   132  
   133  - **Content-Type**: Not defined
   134  - **Accept**: application/json
   135  
   136  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   137  [[Back to Model list]](../README.md#documentation-for-models)
   138  [[Back to README]](../README.md)
   139  
   140  
   141  ## UpdateConnectApp
   142  
   143  > ApiV2010ConnectApp UpdateConnectApp(ctx, Sidoptional)
   144  
   145  
   146  
   147  Update a connect-app with the specified parameters
   148  
   149  ### Path Parameters
   150  
   151  
   152  Name | Type | Description
   153  ------------- | ------------- | -------------
   154  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   155  **Sid** | **string** | The Twilio-provided string that uniquely identifies the ConnectApp resource to update.
   156  
   157  ### Other Parameters
   158  
   159  Other parameters are passed through a pointer to a UpdateConnectAppParams struct
   160  
   161  
   162  Name | Type | Description
   163  ------------- | ------------- | -------------
   164  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to update.
   165  **AuthorizeRedirectUrl** | **string** | The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
   166  **CompanyName** | **string** | The company name to set for the Connect App.
   167  **DeauthorizeCallbackMethod** | **string** | The HTTP method to use when calling `deauthorize_callback_url`.
   168  **DeauthorizeCallbackUrl** | **string** | The URL to call using the `deauthorize_callback_method` to de-authorize the Connect App.
   169  **Description** | **string** | A description of the Connect App.
   170  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It can be up to 64 characters long.
   171  **HomepageUrl** | **string** | A public URL where users can obtain more information about this Connect App.
   172  **Permissions** | [**[]ConnectAppEnumPermission**](ConnectAppEnumPermission.md) | A comma-separated list of the permissions you will request from the users of this ConnectApp.  Can include: `get-all` and `post-all`.
   173  
   174  ### Return type
   175  
   176  [**ApiV2010ConnectApp**](ApiV2010ConnectApp.md)
   177  
   178  ### Authorization
   179  
   180  [accountSid_authToken](../README.md#accountSid_authToken)
   181  
   182  ### HTTP request headers
   183  
   184  - **Content-Type**: application/x-www-form-urlencoded
   185  - **Accept**: application/json
   186  
   187  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   188  [[Back to Model list]](../README.md#documentation-for-models)
   189  [[Back to README]](../README.md)
   190