Where to access your Broker Plus API
API Summary
PreApp1003’s rest API is specifically used to receive data into Broker Plus’s CRM. This guide provides a broad overview of how to effectively utilize this API.
Security
In order to maintain a secure environment, we use SSL encryption and a very complex API key that is heavily encrypted. Do not share your API key with anyone, do not publish it in your HTML, JavaScript, or in any public facing page.
API Key
To get your Broker Plus API key specific to your loan originator account only, navigate to CRM > Utilities, at the bottom of the page under API Keys click Add New, name your key, click generate and then click Add Key. Your key is now ready for use.
Endpoint
https://plus.preapp1003.com/crmAPI/[function]
Functions available:
- create
Functions
Function: create
Method: POST
Headers: X-API-KEY = [Your API Key]
In order to directly import your leads into your CRM, use this function and API endpoint to send data directly to PreApp1003.com.
URL structure:
- https://plus.preapp1003.com/crmAPI/create
This endpoint takes no additional arguments but does require JSON payload.
JSON Structure Example:
PHP Example:
Response 200
Response 302
For a response of 302 “The request was successful, contact already in system.” We will email the loan officer the details of the contact informing them we found it in the system.
Example Email:
Type
In the Json payload we have:
Test Contact is the name of a contact type in your CRM simply use the exact spelling to assign users to that contact type.
NOTE: If you pass as an example “Testing” and Testing is not a contact type the system will create it and connect users to it for you.
Zapier
Search for Broker Plus by PreApp 1003.
Keys that map to predefined fields:
Field | Key | Data Type | Format | Accepted Value |
Contact Type* | type | string | See Type section | |
First Name* | first_name | string | ||
Middle Name | middle_name | string | ||
Last Name* | last_name | string | ||
Email Address* | alphanumeric | |||
Cell Phone | cell_phone | numeric | ||
Home Phone | home_phone | numeric | ||
Work Phone | work_phone | numeric | ||
Birthday | dob | date | 2023-09-28T16:47:50+00:00 | UTC or Zulu |
Company Name | company | alphanumeric | ||
Job Title | title | alphanumeric | ||
Work Fax | fax | numeric | ||
Website | website | alphanumeric | ||
Mailing Address | address | alphanumeric | ||
Mailing Suite | suite | alphanumeric | ||
Mailing City | city | string | ||
Mailing State | state | string | Full Name or Abbreviated | |
Mailing Zip Code | zip | numeric | ||
Mailing County | county | string | ||
Mailing Country | country | string | ||
Mid Score | mid_score | numeric | 400-900 | |
Lead Source | lead_source | string | ||
Wedding Anniversary | anniversary | date | 2023-09-28T16:47:50+00:00 | UTC or Zulu |
US Citizen | us_citizen | string | yes, no | |
Veteran | veteran | string | yes, no | |
Custom Field 1 | custom_field_1 | alphanumeric | ||
Custom Field 2 | custom_field_2 | alphanumeric | ||
Custom Field 3 | custom_field_3 | alphanumeric | ||
Custom Field 4 | custom_field_4 | alphanumeric | ||
Custom Field 5 | custom_field_5 | alphanumeric | ||
Custom Field 6 | custom_field_6 | alphanumeric | ||
Custom Field 7 | custom_field_7 | alphanumeric | ||
Custom Field 8 | custom_field_8 | alphanumeric | ||
Custom Field 9 | custom_field_9 | alphanumeric | ||
Custom Field 10 | custom_field_10 | alphanumeric |
*Required fields