Welcome to the documentation for the JSON version of the Anthill API.
Addition methods will be added overtime. If you require anything for the SOAP version, please contact us.
Header
ENDPOINT = https://[ProvidedByAnthill].anthillcrm.com/api/v2/enquiries
X-SUBDOMAIN = [ProvidedByAnthill]
API_KEY = [ProvidedByAnthill]
CreateEnquiry
This method is used to create a new enquiry for an existing customer. Common use cases are to send new enquires from websites into Anthill for response. On creation of the enquiry, the relevant workflow is automatically initiated.
The response contains the Enquiry ID of the created object.
Request Body:
{
"CustomerID": 347,
"LocationID": 15,
"Source": "V2Test",
"TypeID": 2,
"ExternalReference": "XYZ123",
"CustomFields": [
{ "Key": "Budget", "Value": "42.99" },
{ "Key": "Notes", "Value": "Hello World" }
]
}
CreateCustomerEnquiry
This method creates a new Customer and new Enquiry. Common use cases are to send new enquires from websites into Anthill for response. On creation of the enquiry, the relevant workflow is automatically initiated.
The response contains the Enquiry ID of the created object.
Request Body
{
"Customer": {
"LocationID": 15,
"Source": "V2Test",
"TypeID": 1,
"ExternalReference": "Blah111",
"CustomFields": [
{ "Key": "First Name", "Value": "Chris" },
{ "Key": "Last Name", "Value": "Test" },
{ "Key": "Email", "Value": "chris@hotmail.co.uk" }
],
"Address":
{ "Address1": "1 West Road", "Address2": "Sowerby Bridge",
"City": "Halifax", "County": "West Yorkshire", "Country": "UK",
"Postcode": "HX3POH" }
},
"LocationID": 15,
"Source": "V2Test",
"TypeID": 2,
"ExternalReference": "XYZ123",
"CustomFields": [
{ "Key": "Budget", "Value": "42.99" },
{ "Key": "Notes", "Value": "Hello World" }
]
}
If you have any other Integration Queries, please visit the Integrations Hub or Contact Us directly.
Related Articles
- May 20th, 2022