Automated Leads API Documentation

This API allows for companies, properties, contacts, and the opportunity info to automatically transfer into Centerpoint Connect.

Endpoint

POST https://app.centerpointconnect.com/a/leads

Authentication

Pass your jwt token into the Authorization header Autorization: Bearer {token}

Or pass the token as a request parameter https://.../leads?token={token}

Body Format

This endpoint roughly mimics the JSONAPI spec, albeit simplified, and will accept one Lead object. A Lead is an object with type: "leads" and contains a relationships object with at least a company object. It may also contain property, contact, and an opportunity objects.

Example:

{
  "data": {
    "type": "leads",
    "company": {
      "name": "Company Name",
      "externalId": "C123",
      ...
    },
    "property": {
      "name": "Property Name",
      ...
    },
    "contact": {
      "name": "John Doe",
      ...
    },
    opportunity: {
      "price": 2000,
      ...
    }
  }
}

 

Company

Field	Type	Required	Default	Description
name	string	Yes	-	Name of the Company - Will be used to check for duplicates.
externalId	string	-	-	External Company ID - Will be used to check for duplicates.
createDuplicate	boolean	-	false	If false then it will look for an existing company to use for this Lead.
address	string	-	-	Street Address
city	string	-	-	City
state	string	-	-	Two-letter state code, e.g. "IL"
zip	string	-	-	Postal Code
county	string	-	-	County
timezone	string	-	Account Timezone	Timezone Identifier, e.g. "America/Chicago"
accountManager	string	-	-	Name of an Employee in your Account
billingAddress	string	-	-	Full Billing Address (if different then above) - Separate lines by newline characters. e.g. "Mary Manager\n123 Main St.\nChicago, IL 60000"
billingInstructions	string	-	-	Internal billing instructions
custom	object	-	-	An object that contains custom field values. The keys should be the label of the Custom fields. e.g. { "Company Size": "1 Million" }

Property

Field	Type	Required	Default	Description
name	string	Yes	-	Name of the Property
externalId	string	-	-	External Building ID
address	string	-	-	Street Address
city	string	-	-	City
state	string	-	-	Two-letter state code, e.g. "IL"
zip	string	-	-	Postal Code
county	string	-	-	County
timezone	string	-	Company Timezone	Timezone Identifier, e.g. "America/Chicago"
custom	object	-	-	An object that contains custom field values. The keys should be the label of the Custom fields. e.g. { "Building Height": "20ft" }

Contact

Field	Type	Required	Default	Description
name	string	Yes	-	Name of the Contact, firstname and lastname e.g. "John Doe"
position	string	-	-	Position of Contact, e.g. "President"
email	email	-	-	Email Address
mobile	phone	-	-	Mobile phone number, e.g. "[phone]"
office	phone	-	-	Office phone number with optional extension, e.g. "[phone] x 123"
custom	object	-	-	An object that contains custom field values. The keys should be the label of the Custom fields. e.g. { "Answers Phone?": "Yes" }

Opportunity

Field	Type	Required	Default	Description
leadType	string	-	-	Name of Lead Type, must match a Lead Type in your Account
manager	string	-	-	Name of an Employee in your Account. If a Manager is given, a Task will be created for them.
product	string	-	-	Name of a Product (aka Opportunity Type) in your Account
price	number	-	0	Sales Price of the Opportunity
forecasted	boolean	-	false	Is this opportunity forecasted to close?
notes	string	-	-	Additional notes for the Opportunity
custom	object	-	-	An object that contains custom field values. The keys should be the label of the Custom fields. e.g. { "First Contact Date": "07/12/2023" }