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

     1  # WorkspacesActivitiesApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateActivity**](WorkspacesActivitiesApi.md#CreateActivity) | **Post** /v1/Workspaces/{WorkspaceSid}/Activities | 
     8  [**DeleteActivity**](WorkspacesActivitiesApi.md#DeleteActivity) | **Delete** /v1/Workspaces/{WorkspaceSid}/Activities/{Sid} | 
     9  [**FetchActivity**](WorkspacesActivitiesApi.md#FetchActivity) | **Get** /v1/Workspaces/{WorkspaceSid}/Activities/{Sid} | 
    10  [**ListActivity**](WorkspacesActivitiesApi.md#ListActivity) | **Get** /v1/Workspaces/{WorkspaceSid}/Activities | 
    11  [**UpdateActivity**](WorkspacesActivitiesApi.md#UpdateActivity) | **Post** /v1/Workspaces/{WorkspaceSid}/Activities/{Sid} | 
    12  
    13  
    14  
    15  ## CreateActivity
    16  
    17  > TaskrouterV1Activity CreateActivity(ctx, WorkspaceSidoptional)
    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  **WorkspaceSid** | **string** | The SID of the Workspace that the new Activity belongs to.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateActivityParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **FriendlyName** | **string** | A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.
    39  **Available** | **bool** | Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.
    40  
    41  ### Return type
    42  
    43  [**TaskrouterV1Activity**](TaskrouterV1Activity.md)
    44  
    45  ### Authorization
    46  
    47  [accountSid_authToken](../README.md#accountSid_authToken)
    48  
    49  ### HTTP request headers
    50  
    51  - **Content-Type**: application/x-www-form-urlencoded
    52  - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    55  [[Back to Model list]](../README.md#documentation-for-models)
    56  [[Back to README]](../README.md)
    57  
    58  
    59  ## DeleteActivity
    60  
    61  > DeleteActivity(ctx, WorkspaceSidSid)
    62  
    63  
    64  
    65  
    66  
    67  ### Path Parameters
    68  
    69  
    70  Name | Type | Description
    71  ------------- | ------------- | -------------
    72  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73  **WorkspaceSid** | **string** | The SID of the Workspace with the Activity resources to delete.
    74  **Sid** | **string** | The SID of the Activity resource to delete.
    75  
    76  ### Other Parameters
    77  
    78  Other parameters are passed through a pointer to a DeleteActivityParams struct
    79  
    80  
    81  Name | Type | Description
    82  ------------- | ------------- | -------------
    83  
    84  ### Return type
    85  
    86   (empty response body)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: Not defined
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## FetchActivity
   103  
   104  > TaskrouterV1Activity FetchActivity(ctx, WorkspaceSidSid)
   105  
   106  
   107  
   108  
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **WorkspaceSid** | **string** | The SID of the Workspace with the Activity resources to fetch.
   117  **Sid** | **string** | The SID of the Activity resource to fetch.
   118  
   119  ### Other Parameters
   120  
   121  Other parameters are passed through a pointer to a FetchActivityParams struct
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  
   127  ### Return type
   128  
   129  [**TaskrouterV1Activity**](TaskrouterV1Activity.md)
   130  
   131  ### Authorization
   132  
   133  [accountSid_authToken](../README.md#accountSid_authToken)
   134  
   135  ### HTTP request headers
   136  
   137  - **Content-Type**: Not defined
   138  - **Accept**: application/json
   139  
   140  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   141  [[Back to Model list]](../README.md#documentation-for-models)
   142  [[Back to README]](../README.md)
   143  
   144  
   145  ## ListActivity
   146  
   147  > []TaskrouterV1Activity ListActivity(ctx, WorkspaceSidoptional)
   148  
   149  
   150  
   151  
   152  
   153  ### Path Parameters
   154  
   155  
   156  Name | Type | Description
   157  ------------- | ------------- | -------------
   158  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   159  **WorkspaceSid** | **string** | The SID of the Workspace with the Activity resources to read.
   160  
   161  ### Other Parameters
   162  
   163  Other parameters are passed through a pointer to a ListActivityParams struct
   164  
   165  
   166  Name | Type | Description
   167  ------------- | ------------- | -------------
   168  **FriendlyName** | **string** | The `friendly_name` of the Activity resources to read.
   169  **Available** | **string** | Whether return only Activity resources that are available or unavailable. A value of `true` returns only available activities. Values of '1' or `yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.
   170  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   171  **Limit** | **int** | Max number of records to return.
   172  
   173  ### Return type
   174  
   175  [**[]TaskrouterV1Activity**](TaskrouterV1Activity.md)
   176  
   177  ### Authorization
   178  
   179  [accountSid_authToken](../README.md#accountSid_authToken)
   180  
   181  ### HTTP request headers
   182  
   183  - **Content-Type**: Not defined
   184  - **Accept**: application/json
   185  
   186  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   187  [[Back to Model list]](../README.md#documentation-for-models)
   188  [[Back to README]](../README.md)
   189  
   190  
   191  ## UpdateActivity
   192  
   193  > TaskrouterV1Activity UpdateActivity(ctx, WorkspaceSidSidoptional)
   194  
   195  
   196  
   197  
   198  
   199  ### Path Parameters
   200  
   201  
   202  Name | Type | Description
   203  ------------- | ------------- | -------------
   204  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   205  **WorkspaceSid** | **string** | The SID of the Workspace with the Activity resources to update.
   206  **Sid** | **string** | The SID of the Activity resource to update.
   207  
   208  ### Other Parameters
   209  
   210  Other parameters are passed through a pointer to a UpdateActivityParams struct
   211  
   212  
   213  Name | Type | Description
   214  ------------- | ------------- | -------------
   215  **FriendlyName** | **string** | A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.
   216  
   217  ### Return type
   218  
   219  [**TaskrouterV1Activity**](TaskrouterV1Activity.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