Versions Compared

Version Old Version 1 New Version Current
Changes made by

Tristy Lee

Rebecca Kornblum

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

Description

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

This article covers the following information:

Table of Contents
minLevel2
maxLevel7

Assigning Partners to Agents

Partners can be assigned to users in

...

Insellerate using their email address (AssignToEmail) or Unique ID (AssignToUserId).

Creating New Partners

Required Fieldsfields:

  • 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 Fieldsfields:

  • Email

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

...

Sample API Request

Expand
titleExpand to see example
Code Block
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.

Code Block
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

  1. Download the Partner Bulk Upload CSV Template.

  2. 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.

Expand
titleSee values

The values in this column need to must 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 Fieldrequired field)

    • Enter the Partner’s First Name first name.

  • LastName (Required Fieldrequired field)

    • Enter the Partner’s Last Namelast name.

  • Email (Required Fieldrequired field)

    • Enter the Partner’s Email

...

    • email.

    • Warning: if you do not enter a

...

    • Partner 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 city for the Partner.

  • State

    • Enter the State state for the Partner.

  • ExternalIdentifier

  • Branch Association

    • Will determine This determines the branches that can see this Partner.

    • If blank, it will default to All.

Expand
titleSee valuesValues

Branch Association

BranchAssociation

All

1

{{Org-specific branch}}

Please ask your Insellerate representative.

  • Campaign ID

    • Enter the Campaign campaign that the Partner should be associated with.

    • If it the campaign 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 the assignee 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 the email 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 postal code for the Partner.

  • UserTitle

    • Enter the professional title for your Partner if applicable.

  • ApprovalStatusID

    • Can This can be used to define the Partner’s Statusstatus.

Expand
titleSee 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 branch name for your Partner.

  • Branch_Phone

    • Enter a Branch Phone Number branch phone number for your Partner.

  • Branch_Website

    • Enter a Website website for the Branch branch of your Partner.

  • Branch_City

    • Enter a City city for the Branch branch of your Partner.

  • Branch_State

    • Enter a State state for the Branch branch of your Partner.

  • Branch_BranchAssociation

    • Will determine This determines the branches that can see this Partner.

    • If blank, it will default to All.

Expand
titleSee Values

Branch Association

BranchAssociation

All

1

{{Org-specific branch}}

Please ask your Insellerate representative.

  • Branch_Company_Name

    • Add Company Name the company name for your Partner.

  • Branch_Company_Website

    • Enter a Website the website for the Company company of your Partner.

  • Branch_Company_ExternalContactCompanyId

    • Enter a Company Id the company ID for your Partner.

    • This is the Unique unique ID of a Company company assigned by Insellerate.

  • Branch_Company_OrgID

    • Enter a Company the company Organization ID.

  • Branch_Company_UserId

    • Enter the User user ID for your Partner at their Companycompany.

  • Branch_Company_TpoId

    • Enter the Company company TPO ID.

  • Branch_Company_CompanyCode

    • Enter the Company Code company code for your Partner’s Companycompany.

  • Branch_Company_OwnerName

    • Enter the Owner Name owner name for your Partner’s Companycompany.

  • Branch_Company_Phone

    • Enter Company Phone Number the phone number for your Partner’s Companycompany.

  • Branch_Company_Fax

    • Enter the Company Fax Number fax number for your Partner’s Companycompany.

  • Branch_Company_Email

    • Enter the Company Email email for your Partner’s Companycompany.

  • Branch_Company_WebsiteUrl

    • Enter the Company Website company website URL.

  • Branch_Company_NmlsId

    • Enter the Company company NMLS.

  • Branch_Company_SalesRepresentativeUserId

    • Enter the Branch Company Sales Representative User branch company sales representative’s user ID for your Partner’s Companycompany.

  • Branch_Company_City

    • Enter the Branch Company City branch company city for your Partner’s Companycompany.

  • Branch_Company_StateId

    • Enter Company State the state ID for your Partner’s Statestate.

  • Branch_Company_Address1

    • Enter Company Address the address for your Partner’s Statestate.

  • Branch_Company_PostalCode

    • Enter Company Postal Code the postal code for your Partner’s Statestate.

  • Branch_Company_BranchAssociation

    • Will determine This determines the branches that can see this Partner.

    • If blank, it will default to All.

Expand
titleSee Values

Branch Association

BranchAssociation

All

1

{{Org-specific branch}}

Please ask your Insellerate representative.

  • Branch_Company_ExternalContactCompanyLoanProductTypes

    • Enter the Types types of Products products offered by your Partners.

Expand
titleSee 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 loan purpose types offered by your Partners.

Expand
titleSee 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 channel type for your Partner.

Expand
titleSee Values

Channel Type(s)

ExternalContactCompanyChannelTypes

Broker

1

Correspondent

2

Delegated

3

Non-Delegated

4

  • Branch_Company_ApprovalStatusId

    • Define the Company company Partner’s Statusstatus.

Expand
titleSee 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 who work with your Partner on their leads.

  • email2

    • This field can be used by your organization to add emails for team members that who work with your Partner on their leads.

...