github.com/twilio/twilio-go@v1.20.1/rest/sync/v1/docs/ServicesListsApi.md (about) 1 # ServicesListsApi 2 3 All URIs are relative to *https://sync.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateSyncList**](ServicesListsApi.md#CreateSyncList) | **Post** /v1/Services/{ServiceSid}/Lists | 8 [**DeleteSyncList**](ServicesListsApi.md#DeleteSyncList) | **Delete** /v1/Services/{ServiceSid}/Lists/{Sid} | 9 [**FetchSyncList**](ServicesListsApi.md#FetchSyncList) | **Get** /v1/Services/{ServiceSid}/Lists/{Sid} | 10 [**ListSyncList**](ServicesListsApi.md#ListSyncList) | **Get** /v1/Services/{ServiceSid}/Lists | 11 [**UpdateSyncList**](ServicesListsApi.md#UpdateSyncList) | **Post** /v1/Services/{ServiceSid}/Lists/{Sid} | 12 13 14 15 ## CreateSyncList 16 17 > SyncV1SyncList CreateSyncList(ctx, ServiceSidoptional) 18 19 20 21 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Sync List in. 30 31 ### Other Parameters 32 33 Other parameters are passed through a pointer to a CreateSyncListParams struct 34 35 36 Name | Type | Description 37 ------------- | ------------- | ------------- 38 **UniqueName** | **string** | An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource. 39 **Ttl** | **int** | Alias for collection_ttl. If both are provided, this value is ignored. 40 **CollectionTtl** | **int** | How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. 41 42 ### Return type 43 44 [**SyncV1SyncList**](SyncV1SyncList.md) 45 46 ### Authorization 47 48 [accountSid_authToken](../README.md#accountSid_authToken) 49 50 ### HTTP request headers 51 52 - **Content-Type**: application/x-www-form-urlencoded 53 - **Accept**: application/json 54 55 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 56 [[Back to Model list]](../README.md#documentation-for-models) 57 [[Back to README]](../README.md) 58 59 60 ## DeleteSyncList 61 62 > DeleteSyncList(ctx, ServiceSidSid) 63 64 65 66 67 68 ### Path Parameters 69 70 71 Name | Type | Description 72 ------------- | ------------- | ------------- 73 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 74 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to delete. 75 **Sid** | **string** | The SID of the Sync List resource to delete. Can be the Sync List resource's `sid` or its `unique_name`. 76 77 ### Other Parameters 78 79 Other parameters are passed through a pointer to a DeleteSyncListParams struct 80 81 82 Name | Type | Description 83 ------------- | ------------- | ------------- 84 85 ### Return type 86 87 (empty response body) 88 89 ### Authorization 90 91 [accountSid_authToken](../README.md#accountSid_authToken) 92 93 ### HTTP request headers 94 95 - **Content-Type**: Not defined 96 - **Accept**: Not defined 97 98 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 99 [[Back to Model list]](../README.md#documentation-for-models) 100 [[Back to README]](../README.md) 101 102 103 ## FetchSyncList 104 105 > SyncV1SyncList FetchSyncList(ctx, ServiceSidSid) 106 107 108 109 110 111 ### Path Parameters 112 113 114 Name | Type | Description 115 ------------- | ------------- | ------------- 116 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 117 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to fetch. 118 **Sid** | **string** | The SID of the Sync List resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`. 119 120 ### Other Parameters 121 122 Other parameters are passed through a pointer to a FetchSyncListParams struct 123 124 125 Name | Type | Description 126 ------------- | ------------- | ------------- 127 128 ### Return type 129 130 [**SyncV1SyncList**](SyncV1SyncList.md) 131 132 ### Authorization 133 134 [accountSid_authToken](../README.md#accountSid_authToken) 135 136 ### HTTP request headers 137 138 - **Content-Type**: Not defined 139 - **Accept**: application/json 140 141 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 142 [[Back to Model list]](../README.md#documentation-for-models) 143 [[Back to README]](../README.md) 144 145 146 ## ListSyncList 147 148 > []SyncV1SyncList ListSyncList(ctx, ServiceSidoptional) 149 150 151 152 153 154 ### Path Parameters 155 156 157 Name | Type | Description 158 ------------- | ------------- | ------------- 159 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 160 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resources to read. 161 162 ### Other Parameters 163 164 Other parameters are passed through a pointer to a ListSyncListParams struct 165 166 167 Name | Type | Description 168 ------------- | ------------- | ------------- 169 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 170 **Limit** | **int** | Max number of records to return. 171 172 ### Return type 173 174 [**[]SyncV1SyncList**](SyncV1SyncList.md) 175 176 ### Authorization 177 178 [accountSid_authToken](../README.md#accountSid_authToken) 179 180 ### HTTP request headers 181 182 - **Content-Type**: Not defined 183 - **Accept**: application/json 184 185 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 186 [[Back to Model list]](../README.md#documentation-for-models) 187 [[Back to README]](../README.md) 188 189 190 ## UpdateSyncList 191 192 > SyncV1SyncList UpdateSyncList(ctx, ServiceSidSidoptional) 193 194 195 196 197 198 ### Path Parameters 199 200 201 Name | Type | Description 202 ------------- | ------------- | ------------- 203 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 204 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to update. 205 **Sid** | **string** | The SID of the Sync List resource to update. Can be the Sync List resource's `sid` or its `unique_name`. 206 207 ### Other Parameters 208 209 Other parameters are passed through a pointer to a UpdateSyncListParams struct 210 211 212 Name | Type | Description 213 ------------- | ------------- | ------------- 214 **Ttl** | **int** | An alias for `collection_ttl`. If both are provided, this value is ignored. 215 **CollectionTtl** | **int** | How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. 216 217 ### Return type 218 219 [**SyncV1SyncList**](SyncV1SyncList.md) 220 221 ### Authorization 222 223 [accountSid_authToken](../README.md#accountSid_authToken) 224 225 ### HTTP request headers 226 227 - **Content-Type**: application/x-www-form-urlencoded 228 - **Accept**: application/json 229 230 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 231 [[Back to Model list]](../README.md#documentation-for-models) 232 [[Back to README]](../README.md) 233