2.0

API change history

Create and view leads in Enquire CRM. This API is most commonly used for integrations with online Forms or for pushing Leads into EnquireCRM.

need to request a developer account at https://developer.enquiresolutions.com/signup and a subscription to "Basic Unlimited".

Individual: POST

Creates a new individual, a new inquiry activity, and a note in EnquireLEADS. If the individual already exists it will display the individual on the dashboard of the CRM.

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

CommunityName: This needs to be the NameUnique of the community you are sending the individual to. If there is more than one community please use a comma as the delimiter. Example: "OakCommunity,WillowCommunity,ElmCommunity" *required

FirstName: First name of the individual *required

LastName: Last name of the individual *required

HomePhone: Home phone

WorkPhone: Work phone

MobilePhone: Mobile phone

Message: Message from the individual

AddressLine1: Address line 1

AddressLine2: Address line 2

City: City

State: State

ZipCode: Zipcode

Email: Email

NewsLetters: Which newsletters the individual wishes to receive

CommunitiesRequested: Requests for information on these communities

IndividualTypeName: You can create the individual as a Prospect, Resident, Contact, or Pre Lead. It will default to Prospect if nothing is entered.

ActivityTypeName: The name of the activity type that gets created as Inquiry. It will default to type Web Form if nothing is entered. This is important so you can track by which sources leads are entered.

MarketSource: The name of the market source from this list

ActivityDescription: Name of the activity for the individual

ContactFirstName: First name of the primary contact

ContactLastName: Last name of the primary contact

ContactHomePhone: Primary Contact Home phone

ContactWorkPhone: Primary Contact Work phone

ContactMobilePhone: Primary Contact Mobile phone

ContactAddressLine1: Primary Contact Address line 1

ContactAddressLine2: Primary Contact Address line 2

ContactCity: Primary Contact City

ContactState: Primary Contact State

ContactZipCode: Primary Contact Zipcode

ContactEmail: Primary Contact Email

ContactRelationship Primary Contact Relationship to Individual (Lead or Prospect). Values can be:
Contact
Daughter
Son
Friend
Granddaughter
Grandson
Brother
Sister
Spouse
Trusted Advisor
Step-Daughter
Step-Son
Son-in-law
Daughter-in-law
Extended Family Member

IntegrationId: If you want to store an ID of your own. We will find the record and update if you pass this Id.

{
  "CommunityName": "QACommunityOne",
  "FirstName": "John",
  "LastName": "Smith",
  "HomePhone": "",
  "WorkPhone": "",
  "MobilePhone": "",
  "Message": "",
  "AddressLine1": "",
  "AddressLine2": "",
  "City": "",
  "State": "",
  "ZipCode": "",
  "Email": "",
  "NewsLetters": "",
  "CommunitiesRequested": "",
  "IndividualTypeName": "Prospect",
  "ActivityTypeName": "Web Form",
  "MarketSource": "",
  "ActivityDescription": "",
  "ContactFirstName": "",
  "ContactLastName": "",
  "ContactHomePhone": "",
  "ContactWorkPhone": "",
  "ContactMobilePhone": "",
  "ContactAddressLine1": "",
  "ContactAddressLine2": "",
  "ContactCity": "",
  "ContactState": "",
  "ContactZipCode": "",
  "ContactEmail": "",
  "ContactRelationship": "",
  "IntegrationId": "",
  "CareType": ""
}

Responses

200 OK

Individual was created successfully. Returns id.

Representations

400 Bad Request

Missing or invalid field or badly formed request

500 Internal Server Error

There was an error when creating an individual. If this occurs please contact Enquire Support

Code samples

@ECHO OFF

curl -v -X POST "https://api2.enquiresolutions.com/2/Individual/"
-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://api2.enquiresolutions.com/2/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/2/Individual/");


            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://api2.enquiresolutions.com/2/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/2/Individual/";
    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://api2.enquiresolutions.com/2/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
);

$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('api2.enquiresolutions.com')
    conn.request("POST", "/2/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({
})

try:
    conn = http.client.HTTPSConnection('api2.enquiresolutions.com')
    conn.request("POST", "/2/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/2/Individual/')

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