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

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