github.com/twilio/twilio-go@v1.20.1/rest/conversations/v1/docs/ServicesUsersApi.md (about)

     1  # ServicesUsersApi
     2  
     3  All URIs are relative to *https://conversations.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateServiceUser**](ServicesUsersApi.md#CreateServiceUser) | **Post** /v1/Services/{ChatServiceSid}/Users | 
     8  [**DeleteServiceUser**](ServicesUsersApi.md#DeleteServiceUser) | **Delete** /v1/Services/{ChatServiceSid}/Users/{Sid} | 
     9  [**FetchServiceUser**](ServicesUsersApi.md#FetchServiceUser) | **Get** /v1/Services/{ChatServiceSid}/Users/{Sid} | 
    10  [**ListServiceUser**](ServicesUsersApi.md#ListServiceUser) | **Get** /v1/Services/{ChatServiceSid}/Users | 
    11  [**UpdateServiceUser**](ServicesUsersApi.md#UpdateServiceUser) | **Post** /v1/Services/{ChatServiceSid}/Users/{Sid} | 
    12  
    13  
    14  
    15  ## CreateServiceUser
    16  
    17  > ConversationsV1ServiceUser CreateServiceUser(ctx, ChatServiceSidoptional)
    18  
    19  
    20  
    21  Add a new conversation user to your service
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateServiceUserParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **XTwilioWebhookEnabled** | **string** | The X-Twilio-Webhook-Enabled HTTP request header
    39  **Identity** | **string** | The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.
    40  **FriendlyName** | **string** | The string that you assigned to describe the resource.
    41  **Attributes** | **string** | The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.
    42  **RoleSid** | **string** | The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user.
    43  
    44  ### Return type
    45  
    46  [**ConversationsV1ServiceUser**](ConversationsV1ServiceUser.md)
    47  
    48  ### Authorization
    49  
    50  [accountSid_authToken](../README.md#accountSid_authToken)
    51  
    52  ### HTTP request headers
    53  
    54  - **Content-Type**: application/x-www-form-urlencoded
    55  - **Accept**: application/json
    56  
    57  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    58  [[Back to Model list]](../README.md#documentation-for-models)
    59  [[Back to README]](../README.md)
    60  
    61  
    62  ## DeleteServiceUser
    63  
    64  > DeleteServiceUser(ctx, ChatServiceSidSidoptional)
    65  
    66  
    67  
    68  Remove a conversation user from your service
    69  
    70  ### Path Parameters
    71  
    72  
    73  Name | Type | Description
    74  ------------- | ------------- | -------------
    75  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    76  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the User resource from.
    77  **Sid** | **string** | The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.
    78  
    79  ### Other Parameters
    80  
    81  Other parameters are passed through a pointer to a DeleteServiceUserParams struct
    82  
    83  
    84  Name | Type | Description
    85  ------------- | ------------- | -------------
    86  **XTwilioWebhookEnabled** | **string** | The X-Twilio-Webhook-Enabled HTTP request header
    87  
    88  ### Return type
    89  
    90   (empty response body)
    91  
    92  ### Authorization
    93  
    94  [accountSid_authToken](../README.md#accountSid_authToken)
    95  
    96  ### HTTP request headers
    97  
    98  - **Content-Type**: Not defined
    99  - **Accept**: Not defined
   100  
   101  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   102  [[Back to Model list]](../README.md#documentation-for-models)
   103  [[Back to README]](../README.md)
   104  
   105  
   106  ## FetchServiceUser
   107  
   108  > ConversationsV1ServiceUser FetchServiceUser(ctx, ChatServiceSidSid)
   109  
   110  
   111  
   112  Fetch a conversation user from your service
   113  
   114  ### Path Parameters
   115  
   116  
   117  Name | Type | Description
   118  ------------- | ------------- | -------------
   119  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   120  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the User resource from.
   121  **Sid** | **string** | The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.
   122  
   123  ### Other Parameters
   124  
   125  Other parameters are passed through a pointer to a FetchServiceUserParams struct
   126  
   127  
   128  Name | Type | Description
   129  ------------- | ------------- | -------------
   130  
   131  ### Return type
   132  
   133  [**ConversationsV1ServiceUser**](ConversationsV1ServiceUser.md)
   134  
   135  ### Authorization
   136  
   137  [accountSid_authToken](../README.md#accountSid_authToken)
   138  
   139  ### HTTP request headers
   140  
   141  - **Content-Type**: Not defined
   142  - **Accept**: application/json
   143  
   144  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   145  [[Back to Model list]](../README.md#documentation-for-models)
   146  [[Back to README]](../README.md)
   147  
   148  
   149  ## ListServiceUser
   150  
   151  > []ConversationsV1ServiceUser ListServiceUser(ctx, ChatServiceSidoptional)
   152  
   153  
   154  
   155  Retrieve a list of all conversation users in your service
   156  
   157  ### Path Parameters
   158  
   159  
   160  Name | Type | Description
   161  ------------- | ------------- | -------------
   162  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   163  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the User resources from.
   164  
   165  ### Other Parameters
   166  
   167  Other parameters are passed through a pointer to a ListServiceUserParams struct
   168  
   169  
   170  Name | Type | Description
   171  ------------- | ------------- | -------------
   172  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   173  **Limit** | **int** | Max number of records to return.
   174  
   175  ### Return type
   176  
   177  [**[]ConversationsV1ServiceUser**](ConversationsV1ServiceUser.md)
   178  
   179  ### Authorization
   180  
   181  [accountSid_authToken](../README.md#accountSid_authToken)
   182  
   183  ### HTTP request headers
   184  
   185  - **Content-Type**: Not defined
   186  - **Accept**: application/json
   187  
   188  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   189  [[Back to Model list]](../README.md#documentation-for-models)
   190  [[Back to README]](../README.md)
   191  
   192  
   193  ## UpdateServiceUser
   194  
   195  > ConversationsV1ServiceUser UpdateServiceUser(ctx, ChatServiceSidSidoptional)
   196  
   197  
   198  
   199  Update an existing conversation user in your service
   200  
   201  ### Path Parameters
   202  
   203  
   204  Name | Type | Description
   205  ------------- | ------------- | -------------
   206  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   207  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.
   208  **Sid** | **string** | The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
   209  
   210  ### Other Parameters
   211  
   212  Other parameters are passed through a pointer to a UpdateServiceUserParams struct
   213  
   214  
   215  Name | Type | Description
   216  ------------- | ------------- | -------------
   217  **XTwilioWebhookEnabled** | **string** | The X-Twilio-Webhook-Enabled HTTP request header
   218  **FriendlyName** | **string** | The string that you assigned to describe the resource.
   219  **Attributes** | **string** | The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.
   220  **RoleSid** | **string** | The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user.
   221  
   222  ### Return type
   223  
   224  [**ConversationsV1ServiceUser**](ConversationsV1ServiceUser.md)
   225  
   226  ### Authorization
   227  
   228  [accountSid_authToken](../README.md#accountSid_authToken)
   229  
   230  ### HTTP request headers
   231  
   232  - **Content-Type**: application/x-www-form-urlencoded
   233  - **Accept**: application/json
   234  
   235  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   236  [[Back to Model list]](../README.md#documentation-for-models)
   237  [[Back to README]](../README.md)
   238