3.0
API change historyREST API with full access to Enquire Objects and meta-data for CRUD operations.
Request
Request URL
Request parameters
-
number
This is your company Id. You can request this value from EnquireLEADS support when registering for the API.
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
This request creates an individual.
communities can be found in the Community GET method (NameUnique property)
integrationid on a individual is OPTIONAL. This is used if you want to keep track of an external system id within EnquireLEADS.
communitymerge on a individual is OPTIONAL. If you want to prevent a merge based on Email, Phone, IntegrationId you should set this to "true".
type, firstname, lastname properties is required for each individual. Types can be: Prospect, Resident, Contact, Referral, and Pre Lead
If you would like to see names of properties you can use the Object GET method to see all properties available on the individual object.
{
"individuals":[
{
"integrationid":"439321",
"communitymerge":false,
"communities":[
{
"NameUnique":"Community1"
},
{
"NameUnique":"Community2"
}
],
"properties":[
{
"property":"firstname",
"value":"Trevor"
},
{
"property":"lastname",
"value":"Smith"
},
{
"property":"type",
"value":"Prospect"
}
],
"activities":[
{
"reInquiry":true,
"description":"Call Out",
"activityStatusId":332,
"activityResultId":617,
"activityTypeMasterId":17
}
],
"addresses":[
{
"AddressLine1":"100 main st",
"AddressLine2":"Unit 101",
"City":"Denver",
"State":"Colorado",
"PostalCode":"80202"
}
],
"notes":[
{
"Message":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. "
},
{
"Message":"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium"
}
]
},
{
"integrationid":"439322",
"communities":[
{
"NameUnique":"Community1"
},
{
"NameUnique":"Community2"
}
],
"relationship":"Son",
"properties":[
{
"property":"email",
"value":"example@enquireleads.com"
},
{
"property":"firstname",
"value":"Ryan"
},
{
"property":"lastname",
"value":"Smith"
},
{
"property":"type",
"value":"Contact"
}
]
}
]
}Responses
200 OK
Individuals created successfully.
Code samples
@ECHO OFF
curl -v -X POST "https://api2.enquiresolutions.com/v3/Individual?PortalId={number}"
-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}");
// Request parameters
queryString["PortalId"] = "{number}";
var uri = "https://api2.enquiresolutions.com/v3/Individual?" + 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://api2.enquiresolutions.com/v3/Individual");
builder.setParameter("PortalId", "{number}");
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
"PortalId": "{number}",
};
$.ajax({
url: "https://api2.enquiresolutions.com/v3/Individual?" + $.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://api2.enquiresolutions.com/v3/Individual";
NSArray* array = @[
// Request parameters
@"entities=true",
@"PortalId={number}",
];
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://api2.enquiresolutions.com/v3/Individual');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'PortalId' => '{number}',
);
$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({
# Request parameters
'PortalId': '{number}',
})
try:
conn = httplib.HTTPSConnection('api2.enquiresolutions.com')
conn.request("POST", "/v3/Individual?%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({
# Request parameters
'PortalId': '{number}',
})
try:
conn = http.client.HTTPSConnection('api2.enquiresolutions.com')
conn.request("POST", "/v3/Individual?%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://api2.enquiresolutions.com/v3/Individual')
query = URI.encode_www_form({
# Request parameters
'PortalId' => '{number}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
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