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

     1  # \CampaignsApi
     2  
     3  All URIs are relative to *https://portal.vacd.biz/api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**PatchCampaignLead**](CampaignsApi.md#PatchCampaignLead) | **Patch** /admin/accounts/{accountId}/campaignLeads/{leadId} | Patch Campaign Lead
     8  [**UpdateCampaignLead**](CampaignsApi.md#UpdateCampaignLead) | **Put** /admin/accounts/{accountId}/campaignLeads/{leadId} | Update Campaign Lead
     9  [**UploadLeads**](CampaignsApi.md#UploadLeads) | **Post** /admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct | Upload Leads
    10  
    11  
    12  
    13  ## PatchCampaignLead
    14  
    15  > CampaignLead PatchCampaignLead(ctx, accountId, leadId, campaignId, campaignLead, optional)
    16  Patch Campaign Lead
    17  
    18  Allows updating of a campaign lead, only updating those fields passed in  Permissions: READ on Account (Permission Override), UPDATE on Campaign
    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  **leadId** | **int32**|  | 
    28  **campaignId** | **int32**|  | 
    29  **campaignLead** | [**CampaignLead**](CampaignLead.md)|  | 
    30   **optional** | ***PatchCampaignLeadOpts** | optional parameters | nil if no parameters
    31  
    32  ### Optional Parameters
    33  
    34  Optional parameters are passed through a pointer to a PatchCampaignLeadOpts struct
    35  
    36  
    37  Name | Type | Description  | Notes
    38  ------------- | ------------- | ------------- | -------------
    39  
    40  
    41  
    42  
    43   **listId** | **optional.Int32**|  | 
    44   **timezoneOption** | **optional.String**|  | 
    45   **duplicateHandling** | **optional.String**| `RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates from this list | [default to RETAIN_ALL]
    46  
    47  ### Return type
    48  
    49  [**CampaignLead**](CampaignLead.md)
    50  
    51  ### Authorization
    52  
    53  [ApiKeyAuth](../README.md#ApiKeyAuth)
    54  
    55  ### HTTP request headers
    56  
    57  - **Content-Type**: application/json
    58  - **Accept**: application/json
    59  
    60  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    61  [[Back to Model list]](../README.md#documentation-for-models)
    62  [[Back to README]](../README.md)
    63  
    64  
    65  ## UpdateCampaignLead
    66  
    67  > CampaignLead UpdateCampaignLead(ctx, accountId, leadId, campaignId, campaignLead, optional)
    68  Update Campaign Lead
    69  
    70  Allows updating of a campaign lead, updating entire lead including fields not passed in.  Permissions: READ on Account (Permission Override), UPDATE on Campaign
    71  
    72  ### Required Parameters
    73  
    74  
    75  Name | Type | Description  | Notes
    76  ------------- | ------------- | ------------- | -------------
    77  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    78  **accountId** | **string**|  | 
    79  **leadId** | **int32**|  | 
    80  **campaignId** | **int32**|  | 
    81  **campaignLead** | [**CampaignLead**](CampaignLead.md)|  | 
    82   **optional** | ***UpdateCampaignLeadOpts** | optional parameters | nil if no parameters
    83  
    84  ### Optional Parameters
    85  
    86  Optional parameters are passed through a pointer to a UpdateCampaignLeadOpts struct
    87  
    88  
    89  Name | Type | Description  | Notes
    90  ------------- | ------------- | ------------- | -------------
    91  
    92  
    93  
    94  
    95   **listId** | **optional.Int32**|  | 
    96   **timezoneOption** | **optional.String**|  | 
    97   **duplicateHandling** | **optional.String**| `RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates from this list | [default to RETAIN_ALL]
    98  
    99  ### Return type
   100  
   101  [**CampaignLead**](CampaignLead.md)
   102  
   103  ### Authorization
   104  
   105  [ApiKeyAuth](../README.md#ApiKeyAuth)
   106  
   107  ### HTTP request headers
   108  
   109  - **Content-Type**: application/json
   110  - **Accept**: application/json
   111  
   112  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   113  [[Back to Model list]](../README.md#documentation-for-models)
   114  [[Back to README]](../README.md)
   115  
   116  
   117  ## UploadLeads
   118  
   119  > UploadLeadsResponse UploadLeads(ctx, accountId, campaignId, uploadLeadsRequest)
   120  Upload Leads
   121  
   122  Uploads a single lead or list of leads to a new or existing list
   123  
   124  ### Required Parameters
   125  
   126  
   127  Name | Type | Description  | Notes
   128  ------------- | ------------- | ------------- | -------------
   129  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   130  **accountId** | **string**|  | 
   131  **campaignId** | **string**|  | 
   132  **uploadLeadsRequest** | [**UploadLeadsRequest**](UploadLeadsRequest.md)|  | 
   133  
   134  ### Return type
   135  
   136  [**UploadLeadsResponse**](UploadLeadsResponse.md)
   137  
   138  ### Authorization
   139  
   140  [ApiKeyAuth](../README.md#ApiKeyAuth)
   141  
   142  ### HTTP request headers
   143  
   144  - **Content-Type**: application/json
   145  - **Accept**: application/json
   146  
   147  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   148  [[Back to Model list]](../README.md#documentation-for-models)
   149  [[Back to README]](../README.md)
   150