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

     1  # AccountsAddressesApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateAddress**](AccountsAddressesApi.md#CreateAddress) | **Post** /2010-04-01/Accounts/{AccountSid}/Addresses.json | 
     8  [**DeleteAddress**](AccountsAddressesApi.md#DeleteAddress) | **Delete** /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json | 
     9  [**FetchAddress**](AccountsAddressesApi.md#FetchAddress) | **Get** /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json | 
    10  [**ListAddress**](AccountsAddressesApi.md#ListAddress) | **Get** /2010-04-01/Accounts/{AccountSid}/Addresses.json | 
    11  [**UpdateAddress**](AccountsAddressesApi.md#UpdateAddress) | **Post** /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json | 
    12  
    13  
    14  
    15  ## CreateAddress
    16  
    17  > ApiV2010Address CreateAddress(ctx, optional)
    18  
    19  
    20  
    21  
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateAddressParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Address resource.
    35  **CustomerName** | **string** | The name to associate with the new address.
    36  **Street** | **string** | The number and street address of the new address.
    37  **City** | **string** | The city of the new address.
    38  **Region** | **string** | The state or region of the new address.
    39  **PostalCode** | **string** | The postal code of the new address.
    40  **IsoCountry** | **string** | The ISO country code of the new address.
    41  **FriendlyName** | **string** | A descriptive string that you create to describe the new address. It can be up to 64 characters long.
    42  **EmergencyEnabled** | **bool** | Whether to enable emergency calling on the new address. Can be: `true` or `false`.
    43  **AutoCorrectAddress** | **bool** | Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
    44  **StreetSecondary** | **string** | The additional number and street address of the address.
    45  
    46  ### Return type
    47  
    48  [**ApiV2010Address**](ApiV2010Address.md)
    49  
    50  ### Authorization
    51  
    52  [accountSid_authToken](../README.md#accountSid_authToken)
    53  
    54  ### HTTP request headers
    55  
    56  - **Content-Type**: application/x-www-form-urlencoded
    57  - **Accept**: application/json
    58  
    59  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    60  [[Back to Model list]](../README.md#documentation-for-models)
    61  [[Back to README]](../README.md)
    62  
    63  
    64  ## DeleteAddress
    65  
    66  > DeleteAddress(ctx, Sidoptional)
    67  
    68  
    69  
    70  
    71  
    72  ### Path Parameters
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    78  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Address resource to delete.
    79  
    80  ### Other Parameters
    81  
    82  Other parameters are passed through a pointer to a DeleteAddressParams struct
    83  
    84  
    85  Name | Type | Description
    86  ------------- | ------------- | -------------
    87  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to delete.
    88  
    89  ### Return type
    90  
    91   (empty response body)
    92  
    93  ### Authorization
    94  
    95  [accountSid_authToken](../README.md#accountSid_authToken)
    96  
    97  ### HTTP request headers
    98  
    99  - **Content-Type**: Not defined
   100  - **Accept**: Not defined
   101  
   102  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   103  [[Back to Model list]](../README.md#documentation-for-models)
   104  [[Back to README]](../README.md)
   105  
   106  
   107  ## FetchAddress
   108  
   109  > ApiV2010Address FetchAddress(ctx, Sidoptional)
   110  
   111  
   112  
   113  
   114  
   115  ### Path Parameters
   116  
   117  
   118  Name | Type | Description
   119  ------------- | ------------- | -------------
   120  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   121  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Address resource to fetch.
   122  
   123  ### Other Parameters
   124  
   125  Other parameters are passed through a pointer to a FetchAddressParams struct
   126  
   127  
   128  Name | Type | Description
   129  ------------- | ------------- | -------------
   130  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to fetch.
   131  
   132  ### Return type
   133  
   134  [**ApiV2010Address**](ApiV2010Address.md)
   135  
   136  ### Authorization
   137  
   138  [accountSid_authToken](../README.md#accountSid_authToken)
   139  
   140  ### HTTP request headers
   141  
   142  - **Content-Type**: Not defined
   143  - **Accept**: application/json
   144  
   145  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   146  [[Back to Model list]](../README.md#documentation-for-models)
   147  [[Back to README]](../README.md)
   148  
   149  
   150  ## ListAddress
   151  
   152  > []ApiV2010Address ListAddress(ctx, optional)
   153  
   154  
   155  
   156  
   157  
   158  ### Path Parameters
   159  
   160  This endpoint does not need any path parameter.
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListAddressParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to read.
   170  **CustomerName** | **string** | The `customer_name` of the Address resources to read.
   171  **FriendlyName** | **string** | The string that identifies the Address resources to read.
   172  **IsoCountry** | **string** | The ISO country code of the Address resources to read.
   173  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   174  **Limit** | **int** | Max number of records to return.
   175  
   176  ### Return type
   177  
   178  [**[]ApiV2010Address**](ApiV2010Address.md)
   179  
   180  ### Authorization
   181  
   182  [accountSid_authToken](../README.md#accountSid_authToken)
   183  
   184  ### HTTP request headers
   185  
   186  - **Content-Type**: Not defined
   187  - **Accept**: application/json
   188  
   189  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   190  [[Back to Model list]](../README.md#documentation-for-models)
   191  [[Back to README]](../README.md)
   192  
   193  
   194  ## UpdateAddress
   195  
   196  > ApiV2010Address UpdateAddress(ctx, Sidoptional)
   197  
   198  
   199  
   200  
   201  
   202  ### Path Parameters
   203  
   204  
   205  Name | Type | Description
   206  ------------- | ------------- | -------------
   207  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   208  **Sid** | **string** | The Twilio-provided string that uniquely identifies the Address resource to update.
   209  
   210  ### Other Parameters
   211  
   212  Other parameters are passed through a pointer to a UpdateAddressParams struct
   213  
   214  
   215  Name | Type | Description
   216  ------------- | ------------- | -------------
   217  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to update.
   218  **FriendlyName** | **string** | A descriptive string that you create to describe the address. It can be up to 64 characters long.
   219  **CustomerName** | **string** | The name to associate with the address.
   220  **Street** | **string** | The number and street address of the address.
   221  **City** | **string** | The city of the address.
   222  **Region** | **string** | The state or region of the address.
   223  **PostalCode** | **string** | The postal code of the address.
   224  **EmergencyEnabled** | **bool** | Whether to enable emergency calling on the address. Can be: `true` or `false`.
   225  **AutoCorrectAddress** | **bool** | Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
   226  **StreetSecondary** | **string** | The additional number and street address of the address.
   227  
   228  ### Return type
   229  
   230  [**ApiV2010Address**](ApiV2010Address.md)
   231  
   232  ### Authorization
   233  
   234  [accountSid_authToken](../README.md#accountSid_authToken)
   235  
   236  ### HTTP request headers
   237  
   238  - **Content-Type**: application/x-www-form-urlencoded
   239  - **Accept**: application/json
   240  
   241  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   242  [[Back to Model list]](../README.md#documentation-for-models)
   243  [[Back to README]](../README.md)
   244