Upload or Update Partners Using an API
- Tristy Lee (Unlicensed)
- Rebecca Kornblum
Description
Partners can be added and updated to Insellerate using an API.
This article covers the following information:
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 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 organization, 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
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.
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 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 for the Partner.
State
Enter the state for the Partner.
ExternalIdentifier
Branch Association
This determines the branches that can see this Partner.
If blank, it will default to All.
Campaign ID
Enter the campaign that the Partner should be associated with.
If 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 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 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 for the Partner.
UserTitle
Enter the professional title for your Partner if applicable.
ApprovalStatusID
This can be used to define the Partner’s status.
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
This determines the branches that can see this Partner.
If blank, it will default to All.
Branch_Company_Name
Add the company name for your Partner.
Branch_Company_Website
Enter the website for the company of your Partner.
Branch_Company_ExternalContactCompanyId
Enter the company ID for your Partner.
This is the unique ID of a company assigned by Insellerate.
Branch_Company_OrgID
Enter the 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 the phone number for your Partner’s company.
Branch_Company_Fax
Enter the fax number for your Partner’s company.
Branch_Company_Email
Enter the 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’s user ID for your Partner’s company.
Branch_Company_City
Enter the branch company city for your Partner’s company.
Branch_Company_StateId
Enter the state ID for your Partner’s state.
Branch_Company_Address1
Enter the address for your Partner’s state.
Branch_Company_PostalCode
Enter the postal code for your Partner’s state.
Branch_Company_BranchAssociation
This determines the branches that can see this Partner.
If blank, it will default to All.
Branch_Company_ExternalContactCompanyLoanProductTypes
Enter the types of products offered by your Partners.
Branch_Company_ExternalContactCompanyLoanPurposeTypes
Enter the loan purpose types offered by your Partners.
Branch_Company_ExternalContactCompanyChannelTypes
Enter the channel type for your Partner.
Branch_Company_ApprovalStatusId
Define the company Partner’s status.
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 who work with your Partner on their leads.
email2
This field can be used by your organization to add emails for team members who work with your Partner on their leads.