Campaign Lead Service

API change history

Campaign Lead generates new business leads to identify target audiences for campaigns. Send leads email permission requests and enable campaign creation.

Check if lead is valid and not the same as a previous campaign lead.

List of recipients and additional information: command. Leads: List of all campaign leads. command. RequestType: The type of request for campaign lead generation: Add, Edit or Delete. command. CompanyId: Company ID of campaign lead. command. ItemId: Item ID for campaign lead. command. Salutation: Salutation of campaign lead. command. FirstName: First name of campaign lead. command. LastName: Last name of campaign lead. command. DisplayName: Display name of campaign lead. command. Phone: Phone number of campaign lead. command. Email: Email address of campaign lead. command. ConsentNeeded: Check if consent is required from lead for campaign creation. command. CompanyId: Company ID of campaign lead.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "ItemId": "string",
  "Salutation": "string",
  "FirstName": "string",
  "LastName": "string",
  "DisplayName": "string",
  "Phone": "string",
  "Email": "string",
  "ConsentNeeded": true,
  "CompanyId": "string"
}
{
  "type": "object",
  "properties": {
    "ItemId": {
      "type": "string"
    },
    "Salutation": {
      "type": "string"
    },
    "FirstName": {
      "type": "string"
    },
    "LastName": {
      "type": "string"
    },
    "DisplayName": {
      "type": "string"
    },
    "Phone": {
      "type": "string"
    },
    "Email": {
      "type": "string"
    },
    "ConsentNeeded": {
      "type": "boolean"
    },
    "CompanyId": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
{
  "ItemId": "string",
  "Salutation": "string",
  "FirstName": "string",
  "LastName": "string",
  "DisplayName": "string",
  "Phone": "string",
  "Email": "string",
  "ConsentNeeded": true,
  "CompanyId": "string"
}
{
  "type": "object",
  "properties": {
    "ItemId": {
      "type": "string"
    },
    "Salutation": {
      "type": "string"
    },
    "FirstName": {
      "type": "string"
    },
    "LastName": {
      "type": "string"
    },
    "DisplayName": {
      "type": "string"
    },
    "Phone": {
      "type": "string"
    },
    "Email": {
      "type": "string"
    },
    "ConsentNeeded": {
      "type": "boolean"
    },
    "CompanyId": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
{
  "ItemId": "string",
  "Salutation": "string",
  "FirstName": "string",
  "LastName": "string",
  "DisplayName": "string",
  "Phone": "string",
  "Email": "string",
  "ConsentNeeded": true,
  "CompanyId": "string"
}
{
  "type": "object",
  "properties": {
    "ItemId": {
      "type": "string"
    },
    "Salutation": {
      "type": "string"
    },
    "FirstName": {
      "type": "string"
    },
    "LastName": {
      "type": "string"
    },
    "DisplayName": {
      "type": "string"
    },
    "Phone": {
      "type": "string"
    },
    "Email": {
      "type": "string"
    },
    "ConsentNeeded": {
      "type": "boolean"
    },
    "CompanyId": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Responses

200 OK

Success

Representations

True
{
  "type": "boolean"
}
True
{
  "type": "boolean"
}

Code samples

@ECHO OFF

curl -v -X POST "https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('stg-ecap.azure-api.net')
    conn.request("POST", "/campaignlead/version/Request/CheckValidAndSameLead?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('stg-ecap.azure-api.net')
    conn.request("POST", "/campaignlead/version/Request/CheckValidAndSameLead?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://stg-ecap.azure-api.net/campaignlead/version/Request/CheckValidAndSameLead')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body