Versions Compared

Version Old Version 1 New Version 2
Changes made by

Tristy Lee (Unlicensed)

Tristy Lee (Unlicensed)

Saved on

Key

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

Upload or Update Partners Using an API Overview

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

Table of Contents
minLevel1
maxLevel7

Assigning Partners to Agents

...

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

...

  • 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

...