github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagevoice_v3.0.0/openapi-spec_leads.json (about)

     1  {
     2      "openapi":"3.0.0",
     3      "info":{
     4         "description":"",
     5         "version":"1.0",
     6         "title":"RingCentral Engage Voice API",
     7         "termsOfService":"https://developers.ringcentral.com"
     8      },
     9      "tags":[
    10         {
    11            "name":"Leads"
    12         }
    13      ],
    14      "paths":{
    15         "/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct":{
    16            "post":{
    17               "tags":[
    18                  "Campaigns"
    19               ],
    20               "summary":"Upload Leads",
    21               "description":"Uploads a single lead or list of leads to a new or existing list",
    22               "operationId":"uploadLeads",
    23               "parameters":[
    24                  {
    25                     "name":"accountId",
    26                     "in":"path",
    27                     "required":true,
    28                     "schema":{
    29                        "type":"string"
    30                     }
    31                  },
    32                  {
    33                     "name":"campaignId",
    34                     "in":"path",
    35                     "required":true,
    36                     "schema":{
    37                        "type":"string"
    38                     }
    39                  }
    40               ],
    41               "requestBody":{
    42                 "required":true,
    43                 "content": {
    44                    "application/json":{
    45                       "schema": {
    46                          "$ref": "#/components/schemas/UploadLeadsRequest"
    47                       }
    48                    }
    49                 }
    50               },
    51               "responses":{
    52                  "200":{
    53                     "description":"Success",
    54                     "content":{
    55                        "application/json":{
    56                           "schema":{
    57                                 "$ref":"#/components/schemas/UploadLeadsResponse"
    58                           }
    59                        }
    60                     }
    61                  }
    62               }
    63            }
    64         },
    65         "/admin/accounts/{accountId}/campaignLeads/{leadId}":{
    66           "put":{
    67              "tags":[
    68                 "Campaigns"
    69              ],
    70              "summary":"Update Campaign Lead",
    71              "description":"Allows updating of a campaign lead, updating entire lead including fields not passed in.\n\nPermissions: READ on Account (Permission Override), UPDATE on Campaign",
    72              "operationId":"updateCampaignLead",
    73              "parameters":[
    74                 {
    75                    "name":"accountId",
    76                    "in":"path",
    77                    "required":true,
    78                    "schema":{
    79                       "type":"string"
    80                    }
    81                 },
    82                 {
    83                    "name":"leadId",
    84                    "in":"path",
    85                    "required":true,
    86                    "schema":{
    87                       "type":"integer"
    88                    }
    89                 },
    90                 {
    91                    "name":"campaignId",
    92                    "in":"query",
    93                    "required":true,
    94                    "schema":{
    95                       "type":"integer"
    96                    }
    97                 },
    98                 {
    99                    "name":"listId",
   100                    "in":"query",
   101                    "required":false,
   102                    "schema":{
   103                       "type":"integer"
   104                    }
   105                 },
   106                 {
   107                    "name":"timezoneOption",
   108                    "in":"query",
   109                    "required":false,
   110                    "schema":{
   111                       "type":"string",
   112                       "enum":["NPA_NXX","ZIPCODE","EXPLICIT","NOT_APPLICABLE"]
   113                    }
   114                 },
   115                 {
   116                    "name":"duplicateHandling",
   117                    "in":"query",
   118                    "required":false,
   119                    "description":"`RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates from this list",
   120                    "schema":{
   121                       "type":"string",
   122                       "enum":[
   123                          "RETAIN_ALL","REMOVE_ALL_EXISTING","REMOVE_FROM_LIST"
   124                       ],
   125                       "default":"RETAIN_ALL"
   126                    }
   127                 }
   128              ],
   129              "requestBody":{
   130                 "required":true,
   131                 "content": {
   132                    "application/json":{
   133                       "schema": {
   134                          "$ref": "#/components/schemas/CampaignLead"
   135                       }
   136                    }
   137                 }
   138               },
   139               "responses":{
   140                 "200":{
   141                    "description":"Success",
   142                    "content":{
   143                       "application/json":{
   144                          "schema":{
   145                                "$ref":"#/components/schemas/CampaignLead"
   146                          }
   147                       }
   148                    }
   149                 }
   150              }
   151           },
   152           "patch":{
   153              "tags":[
   154                 "Campaigns"
   155              ],
   156              "summary":"Patch Campaign Lead",
   157              "description":"Allows updating of a campaign lead, only updating those fields passed in\n\nPermissions: READ on Account (Permission Override), UPDATE on Campaign",
   158              "operationId":"patchCampaignLead",
   159              "parameters":[
   160                 {
   161                    "name":"accountId",
   162                    "in":"path",
   163                    "required":true,
   164                    "schema":{
   165                       "type":"string"
   166                    }
   167                 },
   168                 {
   169                    "name":"leadId",
   170                    "in":"path",
   171                    "required":true,
   172                    "schema":{
   173                       "type":"integer"
   174                    }
   175                 },
   176                 {
   177                    "name":"campaignId",
   178                    "in":"query",
   179                    "required":true,
   180                    "schema":{
   181                       "type":"integer"
   182                    }
   183                 },
   184                 {
   185                    "name":"listId",
   186                    "in":"query",
   187                    "required":false,
   188                    "schema":{
   189                       "type":"integer"
   190                    }
   191                 },
   192                 {
   193                    "name":"timezoneOption",
   194                    "in":"query",
   195                    "required":false,
   196                    "schema":{
   197                       "type":"string",
   198                       "enum":["NPA_NXX","ZIPCODE","EXPLICIT","NOT_APPLICABLE"]
   199                    }
   200                 },
   201                 {
   202                    "name":"duplicateHandling",
   203                    "in":"query",
   204                    "required":false,
   205                    "description":"`RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates from this list",
   206                    "schema":{
   207                       "type":"string",
   208                       "enum":[
   209                          "RETAIN_ALL","REMOVE_ALL_EXISTING","REMOVE_FROM_LIST"
   210                       ],
   211                       "default":"RETAIN_ALL"
   212                    }
   213                 }
   214              ],
   215              "requestBody":{
   216                 "required":true,
   217                 "content": {
   218                    "application/json":{
   219                       "schema": {
   220                          "$ref": "#/components/schemas/CampaignLead"
   221                       }
   222                    }
   223                 }
   224               },
   225               "responses":{
   226                 "200":{
   227                    "description":"Success",
   228                    "content":{
   229                       "application/json":{
   230                          "schema":{
   231                                "$ref":"#/components/schemas/CampaignLead"
   232                          }
   233                       }
   234                    }
   235                 }
   236              }
   237  
   238           }
   239         }
   240      },
   241      "servers":[
   242         {
   243            "url":"https://portal.vacd.biz/api/v1"
   244         }
   245      ],
   246      "components":{
   247         "securitySchemes":{
   248            "bearerAuth":{
   249               "type":"http",
   250               "scheme":"bearer"
   251            }
   252         },
   253         "schemas":{
   254            "Lead":{
   255              "type":"object",
   256               "required":[
   257  "externId"
   258               ],
   259               "properties":{
   260                  "leadPhone":{
   261                     "type":"string",
   262                     "description":                   "multiple values can be submitted with a pipe delimiter between phone numbers"
   263                  },
   264                  "externId":{
   265                     "type":"integer",
   266                     "format":"int64"
   267                  },
   268                  "title":{
   269                     "type":"string"
   270                  },
   271                  "firstName":{
   272                     "type":"string"
   273                  },
   274                  "midName":{
   275                     "type":"string"
   276                  },
   277                  "lastName":{
   278                     "type":"string"
   279                  },
   280                  "suffix":{
   281                     "type":"string"
   282                  },
   283                  "address1":{
   284                     "type":"string"
   285                  },
   286                  "address2":{
   287                     "type":"string"
   288                  },
   289                  "city":{
   290                     "type":"string"
   291                  },
   292                  "state":{
   293                     "type":"string"
   294                  },
   295                  "zip":{
   296                     "type":"string"
   297                  },
   298                  "email":{
   299                     "type":"string"
   300                  },
   301                  "gateKeeper":{
   302                     "type":"string"
   303                  },
   304                  "auxData1":{
   305                 
   306                           "type":"string"
   307                     
   308                  },
   309                  "auxData2":{
   310                
   311                           "type":"string"
   312                     
   313                  },
   314                  "auxData3":{
   315            
   316                           "type":"string"
   317                      
   318                  },
   319                  "auxData4":{
   320                
   321                           "type":"string"
   322         
   323                  },
   324                  "auxData5":{
   325  
   326                           "type":"string"
   327  
   328                  },
   329                  "auxPhone":{
   330                     "type":"string"
   331                  },
   332                  "extendedLeadData":{
   333                    "$ref":"#/components/schemas/ExtendedLeadData"
   334                  }
   335               }
   336            },
   337            "ExtendedLeadData":{
   338               "type":"object",
   339               "properties":{
   340                  "important":{
   341                     "type":"string"
   342                  },
   343                  "interested":{
   344                     "type":"boolean"
   345                  }
   346               }
   347            },
   348            "UploadLeadsResponse":{
   349               "type":"object",
   350                 "required":["message","leadsSupplied","leadsConverted","leadsAccepted","leadsInserted","internalDncCount","dncUploadCount","dncReturnedCount","whitelistCount","uploadFileName","deletedCount","quotaCount","listState","timeZoneOption","hasDeletedLeads","processingResult","processingStatus"],
   351              "properties":{
   352                 "message":{"type":"string","description":"Values can be `Your uploaded lead list has successfully completed processing` or `Your uploaded lead list file processing has failed`"},
   353                 "leadsSupplied":{"type":"integer","format":"int32"},
   354                 "leadsConverted":{"type":"integer","format":"int32"},
   355                 "leadsAccepted":{"type":"integer","format":"int32"},
   356                 "leadsInserted":{"type":"integer","format":"int32"},
   357                 "internalDncCount":{"type":"integer","format":"int32"},
   358                 "dncUploadCount":{"type":"integer","format":"int32"},
   359                 "dncReturnedCount":{"type":"integer","format":"int32"},
   360                 "whitelistCount":{"type":"integer","format":"int32"},
   361                 "uploadFileName":{"type":"string"},
   362                 "deletedCount":{"type":"integer","format":"int32"},
   363                 "quotaCount":{"type":"integer","format":"int32"},
   364                 "listState":{"type":"string"},
   365                 "timeZoneOption":{"type":"string"},
   366                 "hasDeletedLeads":{"type":"boolean"},
   367                 "processingResult":{"type":"string","description":"Values can be `OK` or `Failed`"},
   368                 "processingStatus":{"type":"string","description":"Values can be `DEFAULT_NOT_A_FAILURE` or `GENERAL_FAILURE`"}
   369              }
   370            },
   371            "UploadLeadsRequest":{
   372               "type":"object",
   373               "properties":{
   374                  "listState":{
   375                     "type":"string",
   376                     "enum":[
   377                        "ACTIVE"
   378                     ]
   379                  },
   380                  "duplicateHandling":{
   381                     "type":"string",
   382                     "enum":[
   383                        "RETAIN_ALL",
   384                        "REMOVE_ALL_EXISTING",
   385                        "REMOVE_FROM_LIST"
   386                     ]
   387                  },
   388                  "timeZoneOption":{
   389                     "type":"string",
   390                     "enum":[
   391                        "NPA_NXX",
   392                        "ZIPCODE",
   393                        "EXPLICIT"
   394                     ]
   395                  },
   396                  "description":{
   397                     "type":"string"
   398                  },
   399                  "dialPriority":{
   400                     "type":"string",
   401                     "enum":[
   402                        "IMMEDIATE",
   403                        "NORMAL"
   404                     ],
   405                     "description":"Setting this to `IMMEDIATE` allows you to insert a lead to the top of the dialer cache for immediate dialing if you want a normal insert then do not add this parameter."
   406                  },
   407                  "uploadLeads":{
   408                     "type":"array",
   409                     "items":{
   410                        "$ref":"#/components/schemas/CampaignLead"
   411                     }
   412                  }
   413               }
   414            }
   415         }
   416      }
   417   }