Upload or Update Partners Using an API

Upload or Update Partners Using an API Overview

Partners can be added and updated to Insellerate using an API.

Assigning Partners to Agents

Partners can be assigned to users in Insellerateusing their email address (AssignToEmail) or Unique ID (AssignToUserId)

Creating New Partners

Required Fields:

AssignToEmail or AssignToUserID
CampaignID
Email

Defaults will apply if not added:

If ExternalContactTypeId is not passed, we assign the default value, "Real Estate Agent"
If BranchAssociation is not passed, we assign the default value, "ALL"

Partner Updates

Required Fields:

Email
- If dedupe is turned on for the org, posts with a matching LicenseId will be rejected; however, posts with a matching Email will be updated regardless if dedupe is turned on/off.

Sample API Request

Expand to see example

Post Url: https://app.insellerate.com/api/integration/UpdateExternalContact?orgId={{orgId}}

Request Body:
{
    "ExternalContactTypeId": 0,
    "LicenseId": "string",
    "FirstName": "string",
    "LastName": "string",
    "Email": "string",
    "MobilePhone": "string",
    "WorkPhone": "string",
    "Ext": "string",
    "Website": "string",
    "City": "string",
    "State": "string",
    "ExternalIdentifier": "string",
    "BranchAssociation": [
        0
    ],
    "CampaignId": 0,
    "AssignToEmail": "string",
    "Branch": {
        "Name": "string",
        "Phone": "string",
        "Website": "string",
        "City": "string",
        "State": "string",
        "BranchAssociation": [
            0
        ],
        "Company": {
            "Name": "string",
            "Website": "string",
            "TpoId": "string",
            "CompanyCode": "string",
            "OwnerName": "string",
            "Phone": "string",
            "Fax": "string",
            "Email": "string",
            "WebsiteUrl": "string",
            "NmlsId": "string",
            "SalesRepresentativeUserId": 0,
            "City": "string",
            "StateId": "string",
            "Address1": "string",
            "PostalCode": "string",
            "BranchAssociation": [
                0
            ],
            "ExternalContactCompanyLoanProductTypes": [
                0
            ],
            "ExternalContactCompanyLoanPurposeTypes": [
                0
            ],
            "ExternalContactCompanyChannelTypes": [
                0
            ],
            "ApprovalStatusId": 0
        }
    },
    "Address1": "string",
    "PostalCode": "string",
    "UserTitle": "string",
    "ApprovalStatusId": 0,
    "EntityId": "string",
    "ExternalContactUserPersonas": [
        0
    ],
    "Notes": "string",
    "AvatarUrl": "string",
    "Other1": "string",
    "Other2": "string",
    "Other3": "string",
    "Other4": "string",
    "Other5": "string",
    "Other6": "string",
    "Email1": "string",
    "Email2": "string"
}

Users should receive StatusCode = 1 if the post was successful. A failed post would result in StatusCode = 2.

Example of Successful Response:
{
    "StatusCode": 1,
    "Data": "Succesfully updated external contact 1730 for org id 1001",
    "Message": "External Contact updated successfully",
    "Errors": null,
    "ResponseDate": "2023-01-10T17:13:49.2715085Z"
}

Fields Available for Upload or Update Partners Using an API

Download the Partner Bulk Upload CSV Template
Enter all of the Applicable Fields into the Template

Field Explanations in order of report columns

External ContactTypeID is the Partner type
- If blank, it will default to Referral Partner

See values

The values in this column need to be entered as a Number

Partner Type	ExternalContactTypeId
Real Estate Agent	1
Title Agent	2
Escrow Agent	3
Attorney	4
Financial Planner	5
Insurance Agent	6
Personal	7
Existing Client	8
Builder	9
Mortgage Banker	10
Other	11

LiscenseId
- This field can be used to put a license number associated with your Partner.
FirstName (Required Field)
- Enter the Partner’s First Name
LastName (Required Field)
- Enter the Partner’s Last Name
Email (Required Field)
- Enter the Partner’s Email

Warning if you do not enter a Parter Email in any row the entire upload will fail

MobilePhone
- Enter the Partner’s mobile phone number
WorkPhone
- Enter the Partner’s work phone number
Ext
- Enter a work extension number if applicable
Website
- Enter the website for the Partner
City
- Enter the City for the Partner
State
- Enter the State for the Partner
ExternalIdentifier
Branch Association
- Will determine the branches that can see this Partner
- If blank, it will default to All

See values

Branch Association	BranchAssociation
All	1
{{Org-specific branch}}	Please ask your Insellerate representative.

Campaign ID
- Enter the Campaign that the Partner should be associated with.
- If it is not entered or the system does not find an exact match, it will default to the Default Campaign selected on the Partner Bulk Upload Screen
AssignToUserID
- Leave this field blank if using AssignToUserID
- This is the assignee associated with the Partner.
- If it is not entered or the system does not find an exact match, it will default to the Default Assignee selected on the Partner Bulk Upload Screen
AssignToEmail
- Leave this field blank if using AssignTo
- This is the assignee email address associated with the Partner
- If it is not entered or the system does not find an exact match, it will default to the Default Assignee email from the selection on the Partner Bulk Upload Screen
Address1
- Enter the address for the Partner
PostalCode
- Enter the Postal Code for the Partner
UserTitle
- Enter the professional title for your Partner if applicable
ApprovalStatusID
- Can be used to define the Partner’s Status

See Values

Approval Status	ApprovalStatusId
Application Pending	1
Application Denied	2
Active	3
Inactive	4
Suspended	5
Cancelled	6
Terminated	7

EntityID
- This field can be used to store any value your organization wants to associate with a Partner
- Contact Customer Support to add the field to inFlow in the partner application panel.
Notes
- Add any applicable notes for a Partner
AvatarUrl
- Add a URL linking to a picture of a Partner
Branch_Name
- Add a Branch Name for your Partner
Branch_Phone
- Enter a Branch Phone Number for your Partner
Branch_Website
- Enter a Website for the Branch of your Partner
Branch_City
- Enter a City for the Branch of your Partner
Branch_State
- Enter a State for the Branch of your Partner
Branch_BranchAssociation
- Will determine the branches that can see this Partner
- If blank, it will default to All

See Values

Branch Association	BranchAssociation
All	1
{{Org-specific branch}}	Please ask your Insellerate representative.

Branch_Company_Name
- Add Company Name for your Partner
Branch_Company_Website
- Enter a Website for the Company of your Partner
Branch_Company_ExternalContactCompanyId
- Enter a Company Id for your Partner
- This is the Unique ID of a Company assigned by Insellerate
Branch_Company_OrgID
- Enter a Company Organization ID
Branch_Company_UserId
- Enter the User ID for your Partner at their Company
Branch_Company_TpoId
- Enter the Company TPO ID
Branch_Company_CompanyCode
- Enter the Company Code for your Partner’s Company
Branch_Company_OwnerName
- Enter the Owner Name for your Partner’s Company
Branch_Company_Phone
- Enter Company Phone Number for your Partner’s Company
Branch_Company_Fax
- Enter the Company Fax Number for your Partner’s Company
Branch_Company_Email
- Enter the Company Email for your Partner’s Company
Branch_Company_WebsiteUrl
- Enter the Company Website URL
Branch_Company_NmlsId
- Enter the Company NMLS
Branch_Company_SalesRepresentativeUserId
- Enter the Branch Company Sales Representative User ID for your Partner’s Company
Branch_Company_City
- Enter the Branch Company City for your Partner’s Company
Branch_Company_StateId
- Enter Company State ID for your Partner’s State
Branch_Company_Address1
- Enter Company Address for your Partner’s State
Branch_Company_PostalCode
- Enter Company Postal Code for your Partner’s State
Branch_Company_BranchAssociation
- Will determine the branches that can see this Partner
- If blank, it will default to All

See Values

Branch Association	BranchAssociation
All	1
{{Org-specific branch}}	Please ask your Insellerate representative.

Branch_Company_ExternalContactCompanyLoanProductTypes
- Enter the Types of Products offered by your Partners

See Values

Company Loan Product Type(s)	ExternalContactCompanyLoanProductTypes
Conventional	1
FHA	2
VA	3
USDA	4
HELOC	5
Other	6
FirstLien	7
SecondLien	8

Branch_Company_ExternalContactCompanyLoanPurposeTypes
- Enter the Loan Purpose types offered by your Partners

See Values

Company Loan Purpose Type(s)	ExternalContactCompanyLoanPurposeTypes
Purchase	1
No cash out refinance	2
Cash out refinance	3
Construction	4
Construction Perm	5
Other	6

Branch_Company_ExternalContactCompanyChannelTypes
- Enter the Channel Type for your Partner

See Values

Channel Type(s)	ExternalContactCompanyChannelTypes
Broker	1
Correspondent	2
Delegated	3
Non-Delegated	4

Branch_Company_ApprovalStatusId
- Define the Company Partner’s Status

See Values

Approval Status	ApprovalStatusId
Application Pending	1
Application Denied	2
Active	3
Inactive	4
Suspended	5
Cancelled	6
Terminated	7

Other Fields: Other1, Other2, Other3, Other4, Other5, Other6
- Other fields are optional custom fields that can be used by your organization to store additional applicable data on your Partners.
email1:
- This field can be used by your organization to add emails for team members that work with your Partner on their leads.
email2
- This field can be used by your organization to add emails for team members that work with your Partner on their leads.