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

     1  # UsersApi
     2  
     3  All URIs are relative to *https://frontline-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchUser**](UsersApi.md#FetchUser) | **Get** /v1/Users/{Sid} | 
     8  [**UpdateUser**](UsersApi.md#UpdateUser) | **Post** /v1/Users/{Sid} | 
     9  
    10  
    11  
    12  ## FetchUser
    13  
    14  > FrontlineV1User FetchUser(ctx, Sid)
    15  
    16  
    17  
    18  Fetch a frontline user
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **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.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchUserParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**FrontlineV1User**](FrontlineV1User.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## UpdateUser
    55  
    56  > FrontlineV1User UpdateUser(ctx, Sidoptional)
    57  
    58  
    59  
    60  Update an existing frontline user
    61  
    62  ### Path Parameters
    63  
    64  
    65  Name | Type | Description
    66  ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **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.
    69  
    70  ### Other Parameters
    71  
    72  Other parameters are passed through a pointer to a UpdateUserParams struct
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  **FriendlyName** | **string** | The string that you assigned to describe the User.
    78  **Avatar** | **string** | The avatar URL which will be shown in Frontline application.
    79  **State** | **string** | 
    80  **IsAvailable** | **bool** | Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
    81  
    82  ### Return type
    83  
    84  [**FrontlineV1User**](FrontlineV1User.md)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: application/x-www-form-urlencoded
    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