github.com/grokify/go-ringcentral-client@v0.3.31/engagevoice/v1/client/docs/CampaignLeadsApi.md (about)

     1  # \CampaignLeadsApi
     2  
     3  All URIs are relative to *https://portal.vacd.biz/api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetLeadStates**](CampaignLeadsApi.md#GetLeadStates) | **Get** /admin/accounts/{accountId}/campaignLeads/leadStates | Get Lead States
     8  [**GetSystemDispositions**](CampaignLeadsApi.md#GetSystemDispositions) | **Get** /admin/accounts/{accountId}/campaignLeads/systemDispositions | Get Systems Dispositions
     9  [**SearchLeads**](CampaignLeadsApi.md#SearchLeads) | **Post** /admin/accounts/{accountId}/campaignLeads/leadSearch | Search Leads
    10  
    11  
    12  
    13  ## GetLeadStates
    14  
    15  > []string GetLeadStates(ctx, accountId)
    16  Get Lead States
    17  
    18  Returns a listing of all lead states for an account  Permissions: READ on Account
    19  
    20  ### Required Parameters
    21  
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **accountId** | **string**|  | 
    27  
    28  ### Return type
    29  
    30  **[]string**
    31  
    32  ### Authorization
    33  
    34  [ApiKeyAuth](../README.md#ApiKeyAuth)
    35  
    36  ### HTTP request headers
    37  
    38  - **Content-Type**: Not defined
    39  - **Accept**: application/json
    40  
    41  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    42  [[Back to Model list]](../README.md#documentation-for-models)
    43  [[Back to README]](../README.md)
    44  
    45  
    46  ## GetSystemDispositions
    47  
    48  > []string GetSystemDispositions(ctx, accountId)
    49  Get Systems Dispositions
    50  
    51  Returns a listing of all system dispositions for an account  Permissions: READ on Account
    52  
    53  ### Required Parameters
    54  
    55  
    56  Name | Type | Description  | Notes
    57  ------------- | ------------- | ------------- | -------------
    58  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    59  **accountId** | **string**|  | 
    60  
    61  ### Return type
    62  
    63  **[]string**
    64  
    65  ### Authorization
    66  
    67  [ApiKeyAuth](../README.md#ApiKeyAuth)
    68  
    69  ### HTTP request headers
    70  
    71  - **Content-Type**: Not defined
    72  - **Accept**: application/json
    73  
    74  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    75  [[Back to Model list]](../README.md#documentation-for-models)
    76  [[Back to README]](../README.md)
    77  
    78  
    79  ## SearchLeads
    80  
    81  > []CampaignLeadSearchResultsView SearchLeads(ctx, accountId, campaignLeadSearchCriteria, optional)
    82  Search Leads
    83  
    84  Allows searching of campaign leads for a single campaign  Permissions: READ on Account (Permission Override)
    85  
    86  ### Required Parameters
    87  
    88  
    89  Name | Type | Description  | Notes
    90  ------------- | ------------- | ------------- | -------------
    91  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    92  **accountId** | **string**|  | 
    93  **campaignLeadSearchCriteria** | [**CampaignLeadSearchCriteria**](CampaignLeadSearchCriteria.md)|  | 
    94   **optional** | ***SearchLeadsOpts** | optional parameters | nil if no parameters
    95  
    96  ### Optional Parameters
    97  
    98  Optional parameters are passed through a pointer to a SearchLeadsOpts struct
    99  
   100  
   101  Name | Type | Description  | Notes
   102  ------------- | ------------- | ------------- | -------------
   103  
   104  
   105   **count** | **optional.Int32**|  | 
   106   **page** | **optional.Int32**|  | 
   107   **maxRows** | **optional.Int32**|  | 
   108  
   109  ### Return type
   110  
   111  [**[]CampaignLeadSearchResultsView**](CampaignLeadSearchResultsView.md)
   112  
   113  ### Authorization
   114  
   115  [ApiKeyAuth](../README.md#ApiKeyAuth)
   116  
   117  ### HTTP request headers
   118  
   119  - **Content-Type**: application/json
   120  - **Accept**: application/json
   121  
   122  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   123  [[Back to Model list]](../README.md#documentation-for-models)
   124  [[Back to README]](../README.md)
   125