Difference between revisions of "Integration"

From Online Support Wiki
Jump to navigation Jump to search
Line 898: Line 898:
 
*'''Change''': Change tells NRDS to Change the supplemental record.
 
*'''Change''': Change tells NRDS to Change the supplemental record.
  
==='''<span style="color:#800080">Add a Supplemental Agent Record'''</span>===
+
===='''<span style="color:#800080">Data Sent to NRDS for Supplemental Agent Records'''</span>====
 +
----
 +
The information below is sent to NRDS for supplemental records. During sychnronization '''All''' information is sent, but note the fields that are required.
 +
 
 +
<table border="1" cellpadding="0" cellspacing="0" style="width:836px;border-collapse:collapse;border:none;" width="836">
 +
 +
<tr style="height:23px;">
 +
<td style="width:197px;border:solid #4472C4 1.0pt;border-right:none;background:#4472C4;padding:0in 5.4pt 0in 5.4pt;height:23px;vertical-align:top;"><strong><span style="color:white;"><span style="font-size:12.0pt;">Field Name</span></span></strong></td>
 +
<td style="width:432px;border-top:solid #4472C4 1.0pt;border-left:none;border-bottom:solid #4472C4 1.0pt;border-right:none;background:#4472C4;padding:0in 5.4pt 0in 5.4pt;height:23px;vertical-align:top;"><strong><span style="color:white;"><span style="font-size:12.0pt;">Description</span></span></strong></td>
 +
<td style="width:108px;border-top:solid #4472C4 1.0pt;border-left:none;border-bottom:solid #4472C4 1.0pt;border-right:none;background:#4472C4;padding:0in 5.4pt 0in 5.4pt;height:23px;vertical-align:top;"><strong><span style="color:white;"><span style="font-size:12.0pt;">Data format</span></span></strong></td>
 +
<td style="width:98px;border:solid #4472C4 1.0pt;border-left:none;background:#4472C4;padding:0in 5.4pt 0in 5.4pt;height:23px;vertical-align:top;"><strong><span style="color:white;"><span style="font-size:12.0pt;">Required</span></span></strong></td>
 +
</tr>
 +
<tr style="height:27px;">
 +
<td colspan="4" style="width:836px;border:solid #8EAADB 1.0pt;border-top:none;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:27px;vertical-align:top;"><strong><span style="color:black;"><span style="font-size:12.0pt;">Profile Tab</span></span></strong></td>
 +
</tr>
 +
<tr style="height:39px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;padding:0in 5.4pt 0in 5.4pt;height:39px;vertical-align:top;"><strong><span style="color:black;">License &nbsp;</span></strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:39px;vertical-align:top;"><span style="color:black;">You can use a Supplemental record to indicate that the member has a different License Number (usually in another Office or another Association). &nbsp;License is entered on the Profile tab, in the Professional section. The License sent to NRDS is the <strong>first</strong> license entered.</span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:39px;vertical-align:top;"><span style="color:black;">11 Alpha</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:39px;vertical-align:top;">&nbsp;</td>
 +
</tr>
 +
<tr style="height:21px;">
 +
<td colspan="4" style="width:836px;border:solid #8EAADB 1.0pt;border-top:none;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:21px;vertical-align:top;"><strong><span style="color:black;">Real Estate Tab</span></strong></td>
 +
</tr>
 +
<tr style="height:41px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><strong>NRDS ID</strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><span style="color:black;">The member must exist in NRDS and be an active member in order to add a supplemental record.</span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><span style="color:black;">9 Numeric</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><span style="color:black;">X</span></td>
 +
</tr>
 +
<tr style="height:95px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:95px;vertical-align:top;"><strong><span style="color:black;">Office Number </span></strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:95px;vertical-align:top;"><span style="color:black;">The Supplemental record is used to indicate any other Offices where a member works in addition to the &lsquo;core&rsquo; Office in the Member record.<br />
 +
<br />
 +
Normally, a supplemental Office is used because the member has a different license in another Office.</span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:95px;vertical-align:top;"><span style="color:black;">9 Numeric</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:95px;vertical-align:top;"><span style="color:black;">X</span></td>
 +
</tr>
 +
<tr style="height:167px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;padding:0in 5.4pt 0in 5.4pt;height:167px;vertical-align:top;"><strong><span style="color:black;">Member Type</span></strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:167px;vertical-align:top;"><span style="color:black;">Use this Supplemental record to indicate that the member has a different Member Type (usually in another Office or another Association).<br />
 +
<br />
 +
R: Realtor<br />
 +
RA: Realtor Associate<br />
 +
I: Institute Affiliate Member<br />
 +
S: Association staff<br />
 +
AFF: Affiliate<br />
 +
N: Non-member</span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:167px;vertical-align:top;"><span style="color:black;">Drop-down choice</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:167px;vertical-align:top;"><span style="color:black;">X</span></td>
 +
</tr>
 +
<tr style="height:41px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><strong><span style="color:black;">NRDS Status</span></strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><span style="color:black;">Required. Use this field to indicate the Status of the SUPPLEMENTAL RECORD. For example, you set up a supplemental record to indicate the member worked at another Office. When that is no longer true, you would set the Status of this record to I (Inactive). Again, this Status relates ONLY to this particular supplemental record.<br />
 +
<br />
 +
A: &nbsp;Active<br />
 +
I: Inactive<br />
 +
T: Terminated </span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><span style="color:black;">1 Alpha</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:41px;vertical-align:top;"><span style="color:black;">X</span></td>
 +
</tr>
 +
<tr style="height:58px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;padding:0in 5.4pt 0in 5.4pt;height:58px;vertical-align:top;"><strong><span style="color:black;">Member Subclass</span></strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:58px;vertical-align:top;"><span style="color:black;">Used in conjunction with Member Type by many associations. Again, you would use this in the same manner as Member Type to indicate supplemental information. </span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:58px;vertical-align:top;"><span style="color:black;">4 Alpha</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;padding:0in 5.4pt 0in 5.4pt;height:58px;vertical-align:top;">&nbsp;</td>
 +
</tr>
 +
<tr style="height:35px;">
 +
<td style="width:197px;border:solid #8EAADB 1.0pt;border-top:none;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:35px;vertical-align:top;"><strong><span style="color:black;">Local Join Date</span></strong></td>
 +
<td style="width:432px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:35px;vertical-align:top;"><span style="color:black;">If using this record to add on a Secondary Association to the member, enter the date that the member joined this secondary association.</span></td>
 +
<td style="width:108px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:35px;vertical-align:top;"><span style="color:black;">8 Date</span></td>
 +
<td style="width:98px;border-top:none;border-left:none;border-bottom:solid #8EAADB 1.0pt;border-right:solid #8EAADB 1.0pt;background:#D9E2F3;padding:0in 5.4pt 0in 5.4pt;height:35px;vertical-align:top;">&nbsp;</td>
 +
</tr>
 +
</table>
 +
 
 +
===='''<span style="color:#800080">Add a Supplemental Agent Record'''</span>====
 
----
 
----
  

Revision as of 20:46, 4 December 2019


Contents

Connecting to Constant Contact

Through your GrowthZone software, you can sync contacts in your Lists/Committees to Constant Contact. Any additions, changes or deletions made to lists/committees that you have set to Synchronize Contacts with authorized third party newsletter solution will synchronize to Constant Contact near real-time. See Setting Up Lists/Committees for information on configuring your lists/committees to synchronize to a third party newsletter.

  1. Click Setup in the left-hand navigation panel.
  2. Click Constant Contact in the Integrations section.
    CC Connection.jpg
  3. Click Connect.
    CC Login CP.jpg
  4. Enter your credentials for Constant Contact, and click Log-in.
    CC Allow Access.jpg
  5. Click Allow on the Allow Access screen. This process authorizes the connection between GrowthZone and Constant Contact. Once completed, you will see the ConstantContact status updated to Connected.
CC Connected.jpg

After initial connection, click the Sync button. This will synchronize all of your existing lists/committees, that are set to you Synchronize Contacts with authorized third party newsletter solution, with Constant contact. NOTE: Only contacts with a default/primary email address and where Do Not Contact is not enabled, will be synchronized to Constant Contact.

Constant Contact Synchronization

Once your system is setup to synchronize to Constant Contact, the following additions, edits, and deletions performed in GrowthZone will be sent to Constant Contact in near real-time (usually within ten minutes):

  • A new List/Committee is added to GrowthZone with “Synchronize contacts with authorized third party newsletter” set: The new list/committee is added to Constant Contact.
  • A new contact (with valid default/primary email address) is added to the List/Committee in GrowthZone: The new contact is added within that group in Constant Contact
  • A new contact (with valid default/primary email address) is added to the List/Committee in GrowthZone with Do Not Contact is set: The new contact is NOT synchronized to Constant Contact
  • The “Do Not Contact” check-box is set for an existing contact in the List/Committee within GrowthZone: The existing contact is disabled in Constant Contact, and removed from the list/committee in Constant Contact.
  • The "Do Not Contact" check-box is cleared for an existing contact in the List/Committee within GrowthZone: If the contact, that would previously have been disabled in Constant Contact, is re-enabled.
  • An existing contact's name and/or default email address is changed (and the contact belongs to the List/Committee synched to Constant Contact): The updated contact information is sent to Constant Contact.
  • An existing contact is removed from a List/Committee in GrowthZone: The contact is removed from the List/Committee in Constant Contact. If the contact is not a part of other lists, the contact is disabled.
  • If a List/Committee is deleted from GrowthZone: The List/Committee is deleted from Constant Contact. If there are contacts in the Lists/Committees, and those contacts belong to no other Lists/Committees, they are disabled in Constant Contact.
  • A contact who is in multiple Lists/Committees in GrowthZone is deleted from GrowthZone: The contact is deactivated in Constant Contact.

Mail Chimp Integration


Through your GrowthZone software, you can sync contacts in your Lists/Committees to Mail Chimp. Any additions, changes or deletions made to lists/committees that you have set to Synchronize Contacts with authorized third party newsletter solution will synchronize to Mail Chimp near real-time. See Setting Up Lists/Committees for information on configuring your lists/committees to synchronize to a third party newsletter.

Connecting to Mail Chimp


  1. Click Setup in the left-hand navigation panel.
  2. Click Mail Chimp in the Integrations section.
    MC Setup.jpg
  3. Click Connect.
    Connect to MC.jpg
  4. Enter your credentials for Mail Chimp, and click Log-in.
    Mail Chimp Synch.jpg
    Connection status will show Connected and your Organization Contact Information will be displayed.
  5. Select an Audience from the MailChimp audience drop-down list. All contacts will be brought into MailChimp in this single Audience, tagged with the name of the GrowthZone List/Committee. When sending your emails from MailChimp, you will select this audience, filtered by the desired tag. See more info on Mailchimp Tags and How to Send Emails Filtered by Tags
  6. Click Save.

After initial connection, click the Sync button. This will synchronize all of your existing lists/committees, that are set to you Synchronize Contacts with authorized third party newsletter solution, with Mail Chimp. NOTE: Only contacts with a default/primary email address and where Do Not Contact is not enabled, will be synchronized to Mail Chimp.


Mail Chimp Synchronization


Once your system is connected, the following additions, edits, and deletions performed in GrowthZone will be sent to Mail Chimp in near real-time (usually within ten minutes):

  • A new List/Committee is added to GrowthZone with “Synchronize contacts with authorized third party newsletter” set: The new list/committee is added to Mail Chimp.
  • A new contact (with valid default/primary email address) is added to the List/Committee in GrowthZone: The new contact is added within that group in Mail Chimp.
  • A new contact (with valid default/primary email address) is added to the List/Committee in GrowthZone with Do Not Contact set: The new contact is NOT synchronized to Mail Chimp.
  • The “Do Not Contact” check-box is set for an existing contact in the List/Committee within GrowthZone: The existing contact is unsubscribed in Mail Chimp, and removed from the list/committee in Mail Chimp.
  • The "Do Not Contact" check-box is cleared for an existing contact in the List/Committee within GrowthZone: If the contact, that would previously have been disabled in Mail Chimp, is re-enabled.
  • An existing contact's name and/or default email address is changed (and the contact belongs to the List/Committee synched to Mail Chimp): The updated contact information is sent to Mail Chimp.
  • An existing contact is removed from a List/Committee in GrowthZone: The contact is removed from the List/Committee in Mail Chimp. If the contact is not a part of other lists, the contact is disabled.
  • If a List/Committee is deleted from GrowthZone: The List/Committee is deleted from Mail Chimp. If there are contacts in the Lists/Committees, and those contacts belong to no other Lists/Committees, they are disabled in Mail Chimp.
  • A contact who is in multiple Lists/Committees in GrowthZone is deleted from GrowthZone: The contact is deactivated in Mail Chimp.

Smallest.png

NOTE: If a user unsubscribes from a list via MailChimp, Do Not Contact will be set for the contact on that list in GrowthZone.

GoToWebinar Integration


With GoToWebinar integration, you can create your events in GrowthZone and have the corresponding event create in GoToWebinar. To enable GoToWebinar integration:

  1. Click Setup in the left-hand navigation panel.
  2. Click GoToWebinar in the Integrations section.
    GoTo Integration.jpg
  3. Enter your GoToWebinar user name and password.
  4. Click Connect.

Once you have connected, you will be able to sync your events to GoToWebinar on the event's Overview tab, under General Information. Events synced, will automatically be created in GoToWebinar. When attendees register, they will receive confirmations from GoToWebinar with login instructions.

Higher Logic


The integration between the GrowthZone AMS and your Higher Logic Community site drives object creation in the community from the vast amount of up to date member data that you already track in the GrowthZone AMS. The integration ensures that your members interact with the most up to date member data, boosting member participation, collaboration and retention. Through your GrowthZone software you can sync your lists/committees to Higher Logic.

After the integration is in place, it is not necessary to complete any additional work to ensure that the data reflected on your community site remains synchronized with the GrowthZone AMS. GrowthZone uses Higher Logic's Push API Integration methodology. This type of integration allows GrowthZone to send updates directly to Higher Logic.

One Row.png

NOTE: The integration allows active individual members of lists/committees set to sync with a third party newsletter solution to use their InfoHub credentials to sign in to your Higher Logic communities. Data synced to Higher Logic is used for sharing the login information and cannot be edited in Higher Logic and synced back to GrowthZone.

Higher Logic Authentication


To authenticate with Higher Logic an API Gateway Key and Tenant Code are needed for the Push API method. The API Gateway Key is generated by Higher Logic and the Tenant Code is specific to the client’s Higher Logic’s instance. The Tenant Code is generated by Higher Logic, and is entered into GrowthZone in the Higher Logic integration settings. Click Here for Higher Logic documentation on integration. Please contact support@higherlogic.com and ask for an API key that can be used to integrate your GrowthZone account. If you are just starting with Higher Logic, mention this integration to your Higher Logic Account Manager and he will give you this key.

Higher Logic Synchronization


When synchronized to Higher Logic, GrowthZone will push (near real-time) changes to the following records:

  • Contact Information
  • Organizations
  • Membership Types
  • Lists/committees to which the contact is assigned

We do NOT currently support the following types of updates via our Higher Logic integration:

  • Security Groups
  • Demographics
  • Events
  • Job History
  • Education

One Row.png

NOTE: Individuals are pushed to Higher Logic, not organizations. When setting up lists/committees for synchronization to Higher Logic, ensure that individual contacts are added to the list/committee not a business/organization.


Only the records of Active members associated to groups for which the Synchronize Contacts with authorized third party newsletter solution is enabled will be pushed to Higher Logic. Click Here for information on configuring groups to synchronize to a third party.

Higher Logic refers to lists/committees as Communities. If a new list/committee is pushed to Higher Logic, Higher Logic will automatically create the community, however it will be hidden. These communities will require further configuration in Higher Logic for the correct use, but they will not need to be created. A Higher Logic user with administrative rights would need to access the communities area, configure the community appropriately and un-hide it. Click Here for Higher Logic documentation on managing communities.

Set Up Higher Logic Integration


  1. Select Setup in the Navigation Panel.
  2. Select Higher Logic in the Integrations section. This will open the Higher Logic Integration dialog box.
    Higher Logic Setup.jpg
  3. Click Enabled.
  4. Enter the Tenant Code provided by Higher Logic.
  5. Enter the Tenant API Key from Higher Logic
  6. Click Save.
  7. Once the integration settings have been saved, click the Sync button. This will synchronize all of the lists/committees for which you have enabled Synchronize Contacts with authorized third party newsletter solution to Higher Logic. If you plan on using Single Sign-on, it is important that you do this initial synchronization prior to enabling single sign-on. This ensures that Higher Logic has a record of the users who are attempting to access Higher Logic from the Info Hub.

After initial synchronization, the system will look for additions, changes, and deletions from list/committees that are set to synchronize with Higher Logic and push these changes to Higher Logic within 30 minutes. As access to Higher Logic is intended to be a member benefit, only Active members in the lists/committees will be pushed over to Higher Logic. The List/Committee Setting Do Not Contact has no impact on synchronization for Higher Logic. Higher Logic is used as a community forum, not for email purposes.

Higher Logic Single Sign-on


GrowthZone AMS’s API provides a seamless Web experience across the GrowthZone AMS and other third-party systems. It allows users to login to your Info Hub (Members Only Area) and gain secure access to all related Web sites, including your Higher Logic Community using the same login credentials they would use with the GrowthZone AMS Info Hub. Single Sign-On (SSO) is accomplished by using GrowthZone’s implementation of OAuth 2.0, an industry-standard protocol for authorization.

Only Active members, assigned to lists/committees that are synchronized to Higher Logic will be able to access Higher Logic. If a member is dropped, or removed from a list/committee they will no longer be able to access Higher Logic. Your active staff members will also have access via single sign-on to Higher Logic.

Setting Up Single Sign-on


Smallest.png

NOTE: You must complete the Higher Logic Integration setup prior to setting up Single Sign On. Your members will not be able to sign in if the integration has not been setup.
  1. Select Setup in the Navigation Panel.
  2. Select Higher Logic in the Integrations section. This will open the Higher Logic Integration dialog box.
  3. Click the Show Single Sign-On link in the Info Hub check-box.
    Higher Logic SSO.jpg
  4. Link to HigherLogic Community Site: This is automatically populated and should be the URL for your Higher Logic site. Best practice is to verify that this link is correct.
  5. Optional Custom Term for Community Link: You can customize the Info Hub link, by default the link is named Community.
  6. Optional Custom Icon for Community Link: (Optional) You may enter a a Font Awesome icon to be displayed on the navigation panel for this item in the Info Hub. Visit the Font Awesome website. The icons you choose must be for supported FREE icons version 5.0.12 or less.
  7. Click Save.

The first time a member clicks the Community (or the terminology you have configured) link in the Info Hub, an authorization page will be displayed. The member must click the Grant button to access Higher Logic. The next time the member accesses Higher Logic, the member will automatically be logged in.

HL Log-in Auth.jpg


One Row.png

NOTE: Within Higher Logic there is an Edit Profile option. When this option is selected, the member is re-directed to the GrowthZone Info Hub to update information. This ensures that GrowthZone, the system of record, is accurately updated.

Voter Voice


Voter Voice is a third-party advocacy and lobbying platform. When enabled and linked, Growthzone provides a nightly sync of contact information to Voter Voice, updating records in Voter Voice to reflect changes made in Growthzone. The sync in GrowthZone will batch Active and Courtesy Member contact records and send them to the Voter Voice customer tenant nightly at 00:00 UTC; This is also a one-way sync/push, you should update the contact record in GrowthZone and let it push to Voter Voice.


Use the following steps to enable Voter Voice:

  1. Select Setup in the Navigation Panel.
  2. Select Voter Voice in the Integrations section.
    Voter Voice Integration.jpg
  3. Click the Is Enabled check-box.
  4. Enter the Voter Voice API Key. You must contact Voter Voice to receive this key.
  5. Enter the Voter Voice List Name. . The default list name is “Default List”. The can find this in the Voter Voice admin panel.
  6. Click Save.

Builder Edition Integrations

WMS Export


To simplify the process of uploading member changes to the National Association of Home Builders (NAHB) through WMS, we have integrated the required fields into various areas within the GrowthZone system and provided an export tool will allow you to pull monthly data quickly and easily. This process is only for HBAs that import monthly updates into NAHB.

WMS Export - Initial Setup Considerations


A primary setup function for use of the WMS Export tool is to setup Membership Types that identify the members as NAHB members. Membership types are setup per standard procedures, however, advanced custom fields must be selected to identify the membership type as Builder, Associate or Affiliate. The GrowthZone software uses these custom fields to identify members eligible for export to WMS.

WMS - Transactions Eligible for Export


The following transactions are eligible for export using the WMS Export tool, if all criteria has been met.

New Member


New members will be included in the WMS export file if the following criteria is met:

  • The Member has a Membership Start Date that falls within the report date range.
  • The Member's membership status is Active or Courtesy.
  • The Member has a Primary Contact First Name and Primary Contact Last Name, as well as address information (Address Line 1, State/Province, Postal Code).
  • EITHER the Member data field for NAHB Company ID (Account Number) must have a value OR:
  • Information on the member's General tab is filled out as thoroughly as possible, including address information and the Primary Business Activity Code.
  • There is a paid invoice for a membership that has an NAHB membership type assigned to the membership.

Smallest.png

NOTE: Once WMS receives notification of new members, if the member’s HBA number and subscription id are not provided, it will assign the Member HBA Number and Subscription ID. This must be updated in GrowthZone for future renewals, changes, etc. to be included in the WMS export file.

Renewed Members


Renewed members will be included in the WMS export file if the following criteria is met:

  • The Member data field for HBA Number has a value
  • The Member data field for Subscription ID (MSN) must has value.
  • Must have a paid invoice, in the export date range, for a scheduled billing of a membership that has an NAHB membership type assigned to the membership and has a previous activation.

Contact Info Changed


This transaction occurs when information for the existing contact for a membership is changed. Changes that will trigger this transaction include: Primary contact Phone, primary contact address, primary contact Email, Primary contact First/Last Name, Contact set as primary contact (and has MSN#).

Members where the contact information has changed will be included in the export file if the following criteria is met:

  • The Member data field for HBA Number has a value.
  • The Member data field for Subscription ID (MSN) has a value
  • The Primary Contact data fields for Contact First Name and Contact Last Name have a value.
  • The Primary Contact has Primary Contact Address 1, Primary Contact Address Default City, Primary Contact Default State Province, and Primary Contact Default Postal field information filled out

Company Info Changed


This transaction occurs when the information for the existing company associated with a membership changes. Members where the company info has changed will be included in the export file if the following criteria is met:

  • The Member must have an HBA Number.
  • The Primary Contact must have a Subscription ID (MSN).
  • The Member must have an NAHB Company ID.
  • The Member mailing address must be filled out.
  • The Member's Primary Business Activity Code must be populated.

Member Type Changes


This transaction occurs when there is a change to the type of an existing membership with a membership type that is valid as an NAHB membership (within the export report date range).

Member Type Changes will be included in the export, if the following criteria is met:

  • The Member data field for HBA Number must have a value
  • The Member data field for Subscription ID (MSN) must have a value
  • WMS Requires a valid NAHB Membership type to be sent

WMS Export Validation Errors


Most validation error indicated that something is missing or incorrect for the record, and require attention. Required information, for each transaction type, is evaluated and if errors are found, they will be displayed in the last column of the output file, if you have chosen to include validation errors. Best Practice is to return to the record, and fix the errors, then re-export the file. The example below shows both missing information as well as incorrect information.


Export the WMS File


  1. Click Setup in the left-hand navigation panel.
  2. Click WMS in the Integrations section.
    WMS Export.jpg
  3. Verify that the HBA number for your organization is populated. This number is included for each record in your WMS file.
  4. Click Download WMS.
    WMS Download.jpg
  5. On the WMS Download dialog box you will be able to select:
    • The Month/Year for which you wish to download records
    • Get Validation Errors: Select this option so that you can review any errors in the output file. This will give you an opportunity to return to the records in the database and fix errors prior to importing the file into WMS. The validation errors should NOT be included in the final output file used for import to WMS.
    • Generate with Headers Prior to actually generating the file for import to WMS, you may wish to generate the file with headers. This provides the file to you in an easy to read format. This is NOT the file to be used for WMS import, but may be used for your review and records.
    • Include Cancellations: WMS business rules will automatically drop a member if a renewal invoice has not been paid, so it is not necessary to include the cancellations, but you can do so for review purposes.
    • Only New Members and Renewals that have paid
  6. Click Save. If you have created the file with validation errors and headers, for easy review, after reviewing the file complete the steps above without including headers and validation errors to generate the file needed for the WMS export.

WMS Transaction Id's


The first column in the output file is the Transaction type. The following table describes each transaction type:

ID Description
1 New Member
2 Renewal
3 Cancellation
4 Contact Information Change
5 New Contact
6 Company Information Change
7 New Spike
8 Member Type Change
13 New Company

WMS Mapping NAHB to GrowthZone

The fields listed below are included in the WMS export file. Fields required are dependent on the transaction type being sent.

HBA Field GrowthZone Field Required
HBA Number Account Number for your organization. Displayed beneath the name of your organization on your contact page. X
MSN Membership Number. This number is the subscription number provided by NAHB. It is populated on the contact profile tab, when clicking the membership displayed in the Membership section. X
Local Member Type Membership Status  
NAHB Member Type Membership Type. NAHB Membership Types are: Builder, Associate, Affiliate. These are defined via custom fields within the membership type setup. X
Anniversary Date Expiration Date. This field may be viewed/edited when clicking into the Membership on the profile tab, then clicking into the Membership Type in Membership History. X
NAHB Company ID Organization Account Number. This field may be populated/viewed under the name of the organization on the contact page. The company ID is provided by NAHB/WMS for this member after they sign up for membership. X
Company Name Organization Company Name X
Company Address Line 1 Org primary address line 1 - this field is required for a new member if no Company HBA number is provided X
Company Address Line 2 Org primary address line 2  
Company City Company primary city - this field is required for a new member if no Company HBA number (COID) is provided X
Company State Company primary state - this field is required for a new member if no Company HBA number (COID) is provided X
Company Zip Code Company primary zip code - this field is required for a new member if no Company HBA number (COID) is provided X
Company Phone Company primary phone  
Company Fax Company phone of type fax  
Company Website Company primary website  
Primary Activity Code Primary activity code is selected under Categories on the Profile tab.  The category type is NAHB Business Activity and these codes are defined by NAHB. X
Secondary Activity Code Secondary activity code is selected under categories on the Profile tab.  The category type is NAHB Business Activity and these codes are defined by NAHB.  
Tertiary Activity Code Tertiary activity code is selected under categories on the Profile tab.  The category type is NAHB Business Activity and these codes are defined by NAHB.  
Number of Employees This is a custom field, and is configured on the contacts More Info tab.  
Dollar Volume This is a custom field, and is configured on the contacts More Info tab.  
Number of Units Started This is a custom field, and is configured on the contacts More Info tab.  
NAHB PIN Individual Account Number. This field may be populated/viewed under the name of the individual on the contact’s page. This is an NAHB/WMS generated representative ID. X
First Name Individual Contact’s first name. X
Middle Name Individual Contact’s middle name  
Last Name Individual Contact’s last name X
Suffix Individual Contact’s suffix  
Title Individual Contact’s title  
Contact Address 1 Individual Contact’s primary address line 1 X
Contact Address 2 Individual Contact’s primary address line 2  
Contact City Individual Contact’s primary city X
Contact State Individual Contact’s primary state X
Contact Phone Individual Contact’s primary phone  
Contact Fax Individual Contact’s phone of type fax  
Contact Cell Individual Contact’s phone of type cell  
Contact Email Individual Contact’s primary email address  

REALTOR Edition Integrations


GrowthZone's Real Estate Edition provides features required by most National Association of REALTORs Associations for managing their real estate data. The features include an additional tab on contact records to store real estate data, data sync management, and other necessary resources. The software supports integration to NRDS, various MLS, and Lock-box solutions.

Upon installation of the software, you will work with your on-boarding project manager to configure the settings necessary to seamlessly integrate to the various solutions.

NRDS Integration


The GrowthZone integration with the National Association or REALTORS’ NRDS database provides association staff an easy way to manage their contacts’ NRDS data. Select data entered or changed in GrowthZone is automatically pushed to NRDS, thereby updating agent and office records in NRDS. Data is pushed every ten minutes to ensure your records in NRDS are always up to date.

NRDS Integration Initial Setup


Upon installation of the software, you will work with your on-boarding project manager to configure the settings necessary to seamlessly integrate to NRDS.

Working with Primary Agents


The Agent record in NRDS is the "foundation" of the association. If you are the POE, via GrowthZone you can add and change your primary agent data in NRDS. The ADD will add a new member record in NRDS. A POE can add a member only for an Association ID for which they are the POE. The CHANGE will process the changes sent for an existing member. You cannot change a member that is inactive (Status I or T). Only the POE for the primary association can change a member. Only the POE for the Primary association of the agent can Add an agent to that association or change the agent record.

Agent Data sent to NRDS (Primary)


The table below describes the information sent to NRDS.

Field Name Description Data Format Required
Profile Tab
Last Name Agent’s last name 30 Alpha X
First Name Agent’s first name 12 Alpha X
Middle Agent’s middle name 12 Alpha  
Suffix Family generation and other suffixed - e.g. Jr.  Sr.  III  Esq. Note: do not enter designations here. There is a separate field for those. 3 Alpha  
Common Name Member’s nickname 12 Alpha  
Prefix Formal title which precedes member’s name  Mr. Ms. Mrs. etc, 4 Alpha  
Gender Male/Female 1 Alpha  
Address 1 Street name and number of agent’s address home address. NOTE: Must be marked of usage type Home 30 Alpha X
Address 2   This is a second line of address to be used for additional address information (building number, etc.) 30 Alpha  
City Name of City associated to Home address 21 Alpha X
State State Abbreviation associated to Home address 2 Alpha X
Postal Code   Postal Code associated to Home address 5 Alpha X
PR: Postal Code +4 Standard 4-digit ZIP extension plus 2-digit carrier route, associated to Home Address 6 Alpha  
Address 1 The mailing address where mail should be sent, if different from Office or Home Address. Address should be marked as Primary - Default 30 Alpha  
Address 2 (see above) Additional line for mailing address. 30 Alpha  
City (see above) City for mailing address. 21 Alpha  
State (see above) State abbreviation for mailing address. 2 Alpha  
Postal code (see above) 5-digit zip code for mailing address. 5 Alpha  
PR: Postal code +4 (see above) 4-digit Zip extension plus 2-digit carrier route for mailing address. 6 Alpha  
Phone 3-digit area code + 7-digit members home phone.  for Member’s home phone number – first one marked as Home. There is no need to type in the dash ( -) when entering numbers. 10 Numeric  
Fax 3-digit + 7-digit number for the member’s personal fax.  There is no need to type in the dash ( -) when entering numbers. 10 Numeric  
License Agent’s real estate license number. This must match the format set by state associations. It is the first license entered in the Professional section on the Profile tab. 11 Alpha Required if Member Type is R or RA
Real Estate Tab
NRDS ID The unique, 9-digit NRDS ID for this agent 9 Numeric X
Office Number   The unique 9-digit Office ID where this member is located. This ID must be valid in the office database. You may enter a unique office number, or if you have configured your system to use either MLS ID or NRDS ID this will be automatically set 9 Numeric X
Member Type Type of membership:


R:    Realtor
RA:  Realtor-Associate
I:       Institute Affiliate Member
AFF:  Affiliate of association
N:      Non-member salesperson in Realtor Broker's assessment

S:       Association staff person
Drop-down choice X
NRDS Join Date The date the member joined the association. 8 Date X
NRDS Status Agent status:

A:  Active
I:   Inactive
T:  Terminated
P:  Provisional
S:  Suspend (only available 1/1 - 3/1 every 4 years)

X:  Deceased
Drop-down choice X
MLS Association ID The 4-digit association ID of the member’s primary regional MLS. This is ONLY used with associations that are full owners of their MLS. In general never put data in this unless absolutely sure or contact NAR for guidance. 4 Numeric  
Occupation Name Member’s occupation. This is used for reporting RPAC contributions on various state and federal election reports. 20 Alpha  
Waive Dues Local Indicates if local dues should be waived for the member   Check-box  
Waive Dues State Indicates if state dues should be waived for the member   Check-box  
Waive Dues NAR Indicates if National dues should be waived for the member   Check-box  
Primary State   The state where this member has primary membership. Drop-down list X
Local Join Date Date the member transferred or reinstated into this current Primary association. NOTE: The field Join Date should not change when members move from association to association. Use this field to indicate that move. 8 Date X
Stop Mail Indicates whether or not to exclude active members from mailings, including the Realtor Magazine. Enter Y to stop mailings. Check-box  
Stop Junk Mail Indicates whether or not to stop sending junk mail to this agent. NOTE: Only the member themselves can update this field.   Check-box  
Primary Field of Business Indicates the agent’s primary field of business. One choice only. Drop-down list x
Secondary Fields of Business Indicates the agent’s secondary field(s) of business. Multi-choice Drop-down list  

Add an Agent (Primary)


If you are the POE for an agent, you can add them to your database, and sync this to NRDS.

  1. If the agent does not already exist in your database, click the Quick Actions button, in the header bar, and click Contacts - Add Agent. If the agent already exists in your database, verify that you have have all the required information for the agent, as described in step 3 below, then proceed to step 4.
    Add Agent.jpg
  2. Complete all necessary fields. The fields described below are required (See Agent Data sent to NRDS for detailed descriptions and formatting of the fields.):
    • First Name
    • Last Name
    • Address: Line 1, City, State, Zip: You may enter multiple address, however, one address associated to the agent MUST be designated as Home. This selection is made from the Usage drop-down list.
    Add agent home.jpg
    You must also identify both a Member Preferred Mail (where the member would prefer to receive mail) and Member Preferred Publications (Where the member would prefer to receive their publication(s) ) address. The address that you set as primary will be used, with type and usage settings determining how it will be identified in NRDS.
  3. Click Done.
  4. If the agent's NAR member type is R (Realtor) or RA (Realtor-Associate), the agent's license is required. If not, proceed to Step 5:
    • On the agent's Profile tab, click the Orange plus icon.jpg in the Professional section.
    • Select License from the Category list.
    Add Professional.jpg
    • Enter the License number. This must match the format set by the state associations. All other fields are optional.
    • Click Done.
  5. Select the agent's Real Estate tab.
  6. Click the Sync With NRDS check-box. NOTE: With the sync enabled, after you save this record, the agent information will be sent to NRDS. No further action is required.
  7. Populate the following fields. All data entered will be sent to NRDS, however, only those marked with an asterisk are required (See Agent Data sent to NRDS for detailed descriptions and formatting of the fields.):
    • NRDS Status*: Select Active from the list.
    • NRDS ID*: Enter the agent's 9 digit NRDS ID. If the agent does not have an ID, click the Get NRDS Number button. NOTE: NRDS starting numbers are configured under Setup > NRDS Id and Membership Numbers. NOTE: The Account Number for the agent will automatically be updated to the NRDS ID if Tie Account Number To NRDS Number is enabled under integration settings.
    • NRDS Office ID*: Enter the NRDS Office ID for this agent. The Office must exist in NRDS. If the office does not exist, the record will not be processed.
    • NRDS Join Date*: Enter the date the agent joined the association. This cannot be a future date.
    • Local Join Date: The date the member transferred or reinstated into this current Primary association. NOTE: The field Join Date should not change when members move from association to association. Use this field to indicate that move. This cannot be a future date.
    • MLS Association Id: The 4-digit association ID of the member’s primary regional MLS. ONLY used with associations that are full owners of their MLS. In general never put data in this unless absolutely sure or contact NAR for guidance.
    • Primary Field of Business*: Select the agent's primary field of business.
    • Secondary Field(s) of Business: Select the agent’s secondary field(s) of business. You may select multiple.
    • Occupation Name: The agent’s occupation. This is used for reporting RPAC contributions on various state and federal election reports.
    • Licensing State: The state in which the agent is licensed.
    • Primary State*: Select the state where this member has primary membership.
    • Member Type*: Select this agent's member type.
    • Member Subclass: Used by States and Boards to exchange additional billing types for agents.
    • Waive Dues Local: Check this box to indicate that local dues should be waived for the agent.
    • Waive Dues State: Check this box to indicate that state dues should be waived for the agent.
    • Waive Dues NAR: Check this box to indicate that NAR dues should be waived for this agent.
    • Stop Mail: Indicates whether or not to exclude active members from mailings, including the Realtor Magazine. Check the box to exclude the agent.
    • Stop Fax: Indicates whether the agent wants the fax number to be used. Check this box to indicate that the fax should not be used.
    • Stop Junk Mail: This setting indicates whether the agent wishes to be on NAR's Direct Mail mailing list. Only an agent can change this field in their record. Anything a POE sends to this field will be ignored by NRDS.
  8. Click Done.

The new agent will be synched to NRDS within 10 minutes, no further interaction is required on your part.

One Row.png

NOTE: When adding an agent, if NRDS finds a member record already exists with the same Member ID or License it will process the Add as a Change without the necessity of sending another record. There are two exceptions to this rule: if the Name in the add is different than the Name in the existing record, if the License in the add is different from the License in the existing record. Then NRDS will reject the record and require that the record be sent as a Change rather than an Add. Review the Event Log to ensure that there were no validation errors.

Change/Update an Agent (Primary)


If you are the POE for an agent you can change/update profile and NRDS information via GrowthZone. When Sync With NRDS is enabled on the Real Estate tab, changes to any of the fields described in Agent Data sent to NRDS (Primary) will trigger a synch to NRDS. All fields are sent, not just those that have been changed.

One Row.png

NOTE: NRDS will not process a change on an inactive member (Status of Inactive, Terminated or Deceased). If you want to change the agent’s record you must first change the member back to active or provisional.

Change an Agent's NRDS Status (Primary)


An agent's status can be updated within GrowthZone, and synchronized to NRDS. Agent statuses include:

  • Active
  • Inactive indicates that the member left voluntarily, in good standing. They may have decided not to renew their membership or may have simply resigned or retired from the business.
  • Terminate indicates that the member was dropped because they did not meet an outstanding duty or obligation. This includes an unfulfilled code of ethics violation, hearing, outstanding arbitration obligation or not taking the COE course. In other words, this member did not leave in good standing. Choosing to simply not renew their membership would not fit in this category.
  • Suspend was added to NRDS for the specific purpose of tracking members who had not taken their COE course by December 31 of each quadrennial. If a member does not take the COE course by December 31, 2012 the association must suspend that member, and by March 1 must terminate the member if they have not taken the course. Therefore there should be no members with status S in NRDS after March 1.
  • Provisional status is available for associations who have adopted the Provisional bylaw. It allows you to enter a member into NRDS with a Member Type of REALTOR®/REALTOR® Associate and a Status of Provisional even before they have met all the requirements for orientation, etc. NAR will provide all services to these members (magazines, realtor.org, etc.) as they are considered REALTORS®/REALTOR® Associates with all rights and privileges.

Any update to the agent's status will trigger a CHANGE transaction to NRDS. To update an agent's NRDS status:

  1. Select the agent's Real Estate tab.
  2. Ensure that Sync With NRDS check-box is selected.
  3. Select the desiredNRDS Status*from the list.
  4. Click Save.

Once you have saved, a change transaction is triggered. All fields described in Agent Data sent to NRDS (Primary) will be sent to NRDS within ten minutes, no additional interaction is required on your part.

Supplemental Agent Records


Per the associations’ bylaws, most agents have the opportunity to be a member of more than one association. The member has only one Primary association which is the association through which they pay their National dues. Their Primary local and state associations are stored in the Member record in NRDS. Any other associations that the member joins are known as their secondary associations and are stored in the Member Supplemental record in NRDS. There is no limit on the number of supplemental records attached to a member.

With GrowthZone integration to NRDS, you can:

  • Add: Add tells NRDS to Add the supplemental record.
  • Change: Change tells NRDS to Change the supplemental record.

Data Sent to NRDS for Supplemental Agent Records


The information below is sent to NRDS for supplemental records. During sychnronization All information is sent, but note the fields that are required.

Field Name Description Data format Required
Profile Tab
License   You can use a Supplemental record to indicate that the member has a different License Number (usually in another Office or another Association).  License is entered on the Profile tab, in the Professional section. The License sent to NRDS is the first license entered. 11 Alpha  
Real Estate Tab
NRDS ID The member must exist in NRDS and be an active member in order to add a supplemental record. 9 Numeric X
Office Number The Supplemental record is used to indicate any other Offices where a member works in addition to the ‘core’ Office in the Member record.


Normally, a supplemental Office is used because the member has a different license in another Office.
9 Numeric X
Member Type Use this Supplemental record to indicate that the member has a different Member Type (usually in another Office or another Association).


R: Realtor
RA: Realtor Associate
I: Institute Affiliate Member
S: Association staff
AFF: Affiliate

N: Non-member
Drop-down choice X
NRDS Status Required. Use this field to indicate the Status of the SUPPLEMENTAL RECORD. For example, you set up a supplemental record to indicate the member worked at another Office. When that is no longer true, you would set the Status of this record to I (Inactive). Again, this Status relates ONLY to this particular supplemental record.


A:  Active
I: Inactive

T: Terminated
1 Alpha X
Member Subclass Used in conjunction with Member Type by many associations. Again, you would use this in the same manner as Member Type to indicate supplemental information. 4 Alpha  
Local Join Date If using this record to add on a Secondary Association to the member, enter the date that the member joined this secondary association. 8 Date  

Add a Supplemental Agent Record


If you are not the POE for an agent, but wish to add a supplemental record:

  1. If the agent does not already exist in your database, click the Quick Actions button, in the header bar, and click Contacts - Add Agent. If the agent already exists in your database, verify that you have have all the required information for the agent, as described in step 3 below, then proceed to step 3.
    Add Agent.jpg
  2. Complete all necessary fields. Only the First and Last names are required to add the agent to your GrowthZone database. NOTE: As this is a supplemental record, contact information such as addresses, emails and phone numbers are for your records only. These fields are NOT sent to NRDS as only the POE can add/update this information.
  3. Click the agent's Real Estate tab.
  4. Click Enable Sync to NRDS. NOTE: Data will be sent to NRDS after the record is saved. No additional interaction is required on your part.
  5. In the NRDS section, click the Secondary check-box.
  6. Enter the NRDS information. The fields indicated by an asterisk are required for a secondary (supplemental) record. See Data Sent to NRDS for Supplemental Records for further information about these fields.
    • NRDS Status*: Use this field to indicate the Status of the Supplemental Record.
    • NRDS ID*: Enter the unique 9-digit NRDS ID for the agent.
    • NRDS Office ID*: Enter this agent's office ID. The Supplemental record is used to indicate any other Offices where a member works in addition to the "core" Office in the Member record.
    • NRDS Join Date:
    • Local Join Date
    • MLS Association ID

NRDS - Working with Offices


Although Offices are not "members" of the Realtor organization (the Realtor association is an individual member organization), the Office record must exist because each member must be linked to an office. This follows how licensure works in each state. Also, the office name, address, phone, etc is stored once in the office record so if an office changes the POE does not have to change that information in every agent record.

The POE for the Primary association of the Office can add or change an office for that association:

  • Add tells NRDS to Add the record. If NRDS finds an office record already exists with the same Office ID it will process the Add as a Change without the necessity of sending the record again. There is one exception to this rule: if the Office Name in the Add is different than the Office Name in the existing record then NRDS will reject the record and require that the record be sent as a Change rather than an Add.
  • Change tells NRDS to Change the record. If NRDS finds that an office record does not already exist by checking the Office ID it will process the Change as an Add without the necessity of sending another record.

Data sent to NRDS for a Primary Office


The fields described in the table below are synchronized to NRDS.

Field Name Description Data format Required
Profile Tab
NRDS ID The unique 9-digit ID assigned to this office location. 9 Numeric X
Name Business name of the office 30 Alpha X
Address 1   Street name and address number of the office. First address that is mailing or physical & mailing   30 Alpha X
Address 2 (see above) This is a second line of address to be used for additional address information 30 Alpha  
City (see above) Name of city. 21 Alpha X
State (see above) State abbreviation. 2 Alpha X
Postal Code (see above) The 5-digit US Postal zip code. 5 Alpha X
Postal Code (see above) Standard 4-digit ZIP extension plus 2-digit carrier route. 6 Alpha  
Address 1 The mailing address where mail should be sent, if different from Street Address. First address that is mailing or mailing/physical 30 Alpha  
Address 2 (see above) Additional line for mailing address. 30 Alpha  
City (see above) City for mailing address. 21 Alpha  
State (see above) State abbreviation for mailing address. 2 Alpha  
Postal Code (see above) 5-digit zip code for mailing address. 5 Alpha  
Postal Code (see above) 4-digit Zip extension plus 2-digit carrier route for mailing address. 6 Alpha  
Phone (Main) 3-digit area code for office’s phone number + 7 digit phone number of office. There is no need to type the the dash when entering numbers. Main phone number, if there is no main, then work phone number 10 Numeric X
Phone number – FAX 3-digit area code + 7 dIgit office’s fax number. First number marked as Fax. There is no need to type the the dash when entering numbers. 10 Numeric  
Primary Web URL address Internet address for office’s web page, if any. 80 Alpha  
Email Address Email address for office. 80 Alpha  
Real Estate Tab
NRDS Status Status of the office record:

A  Active
I  Inactive

T  Terminated
Drop-down list X
NRDS ID The unique 9-digit ID assigned to this office location 9 Numeric X
Office DR NRDS ID The Designated Realtor of this company, whether or not they are at this location. This must be a valid 9-digit member ID. 9 Numeric X
NRDS Join Date The date the office joined the association. 8 Date  
Office Non-member Salespersons The number of non-member salespersons affiliated with this office. If the POE has verified there are no non member salespersons in this office, then a zero  '0' must be sent. 5 Numeric X
Primary State The 4-digit State association ID where this office has primary membership. Drop-down list X
Office Manager NRDS ID This field is to track the contact person at this office location when it is not the same as the DR. When adding an Office, if this location's Office Contact Manager is the same as the Member entered for Office Contact DR, this field may be null.  If Null, upon the Add, this field shall default to the same Member ID as was entered in Office Contact DR. 9 Numeric X
Stop Fax Tick this option if the office does not wish the fax number to be used. Check-box  
Stop Mail Tick this option if mail should be stopped to this address. Check-box  
Stop Junk Mail Tick this option if the office does not wish to receive “junk” mail from mailing lists, etc. Check-box  
Additional Office Information – Real Estate Tab
Office Type Used by association to track office type such as Residential, Commercial, Affiliate, etc. 4 Alpha  
Office Formal Name This field can be used to enter the full name of the Office, up to 60 characters. Because the Office Business Name is limited to 30 characters due to mailing restrictions, use this field to fully describe the office name for your own use. 100 Alpha  

NRDS - Add a Primary Office


Adding a new office with NRDS is performed on the Real Estate tab. Offices are not members of NAR, but need to exist in the NRDS database.

Smallest.png

NOTE: If NRDS finds an office record already exists with the same Office ID it will process the Add as a Change without the necessity of sending the record again. There is one exception to this rule: if the Office Name in the Add is different than the Office Name in the existing record then NRDS will reject the record and require that the record be sent as a Change rather than an Add.
  1. If the office does not already exist in your database, add the office as described in Add a New Organization Contact. Ensure to populate all required fields, as described in Data Sent to NRDS for a Primary Office in the table above. If required fields are missing or malformed, the record will be rejected by NRDS.
  2. After adding the office, click the Real Estate tab.
    Realtors Tab - Office1.jpg
  3. Tick Sync with NRDS sync. Once this record is saved, all data will be sent to NRDS.
  4. Complete the following fields, and asterisk denotes a required field. If the field is not populated the sync of this record to NRDS will fail. See Data Sent to NRDS for a Primary Office for a detailed description of each field.
    • NRDS Status*: Select the appropriate status for this office. For a new office, to be activated in NRDS, select Active.
    • NRDS ID*: Enter the NRDS ID for this office, or click the Get NRDS Number button. NOTE: If Tie Account Number To NRDS Number the account number for this office will be automatically updated with the NRDS ID.
    • Office DR NRDS ID*: Enter the NRDS ID of the The Designated REALTOR (DR) for this office. This must be a valid 9-digit member ID. See note below.
    • NRDS Join Date*: The date this office joined NRDS.
    • Local Join Date: The date this office joined your association.
    • MLS Association Id: The MLS ID for this office.
    • Occupation Name:
    • Non-Member Salespersons*: NM is Non-member licensees who work in this Realtor office but choose not to join the association. NOTE: Because it is a required field, if this office does not have any NM Salespersons, you must enter a zero in this field.
    • Primary State: Select the state where this office has primary membership.
    • Office Manager NRDS ID: This field is to track the contact person at this office location when it is not the same as the DR. If this location's Office Contact Manager is the same as the Member entered for Office Contact DR, this field may be left empty.
    • Additional Office Information :
      • Office Type: This field can be used to track office type such as Residential, Commercial, Affiliate, etc.
      • Office Formal Name: This field can be used to enter the full name of the Office, up to 60 characters. Because the Office Business Name is limited to 30 characters due to mailing restrictions, use this field to fully describe the office name for your own use.
  5. Click Save.

One Row.png

IMPORTANT! NRDS requires that the Office DR NRDS ID be sent when you are adding a new office. This requires that the DR exist in your database as an Agent. However, when adding agents to your database, the agent's Office NRDS is required.

NRDS recommends the following process for handling this situation: Enter the NRDS ID of one of your staff members when initially adding the office. After the office has been added, you will then be able to add the DR as an agent associated to the office and update the Office DR NRDS ID for the office.


NRDS - Change a Primary Office Record

Any changes to the NRDS data listed in Data sent to NRDS for a Primary Office will automatically be sent to NRDS as long as Enable Sync to NRDS is checked on the Real Estate tab for the office. All data fields are sent not just those that have changed.

One Row.png

NOTE: If NRDS finds that an office record does not already exist by checking the Office ID it will process the Change as an Add without the necessity of sending another record.
NRDS - Update Primary Office NRDS Status

  1. Click the Real Estate tab.
    Realtors Tab - Office1.jpg
  2. Select the appropriate status from the NRDS Status list.
  3. Click Save.

NRDS - Add a Supplemental (Secondary) Office


The primary association field, in NRDS, indicates which association first added this office. If your association also needs to be associated with this office because you have members linked there, you can add these with via your GrowthZone software, and the supplemental data will be synchronized to NRDS.

  1. If the office does not already exist in your database, add the Office by clicking the Quick Actions button in the header bar, and clicking Contacts - Add Office. NOTE: All contact information (i.e. address, phones, etc.) is for your information only. Only the POE can add/update information for the office.
  1. For the desired office, click the Real Estate tab.
    Office Secondary.jpg
  2. Click Sync with NRDS.
  3. Click Secondary Record.
  4. The following fields are required when adding a secondary (supplemental) office. An asterisk indicates a required field:
    • Office ID*: The unique 9-digit NRDS ID assigned to the office
    • Status*: Select Active from the drop-down list.
    • NM Salesperson Count*: Use the field in this table to report the number of non-member salespersons in this office that the broker will pay for through his Secondary association.
  5. Click Save. The Save button will not be enabled if any of the required fields are missing.

The new supplemental office record will immediately be sent to the NRDS processing queue. All data described in Data Sent to NRDS for Supplemental Office will be sent, no further action on your part is required.

One Row.png

IMPORTANT: You can only add an Office Supplemental record if the Office itself exists on NRDS and is Active. If the office does not exist or is Inactive, NRDS will reject the transaction. Be sure to review the Event Log for errors.

Data Sent to NRDS for Supplemental (Secondary) Office


The table below describes the data sent to NRDS for a supplemental record.

Field Name Description Data Format Required
Real Estate Tab      
NRDS ID The unique 9-digit NRDS ID assigned to the office 9 Numeric X
NRDS Status Use this field to indicate the Status of the supplemental record.  NOTE: NRDS treats the two inactive statuses the same – they are both inactive offices whether you use I or T. This status only relates to this supplemental record. Drop-down list:

Active
Inactive

Terminated
X
Office Non-member Salespersons Use the field in this table to report the number of non-member salespersons in this office that the broker will pay for through his Secondary association. 5 Numeric X
Change a Supplemental (Secondary) Office Record

The CHANGE will process the changes sent for an existing office supplemental. You cannot change the OfficeID/AssociationID. You would need to inactivate the record and add a new one. Only the POE who added the office supplemental record can change it. When Sync With NRDS is checked, on the Real Estate tab, any changes made to the fields listed Data Sent to NRDS for Supplemental Office will trigger a change transaction. All fields will be sent, not just those that you have changed.

  1. For the desired office, click the Realtor tab.
    Office Secondary.jpg
  2. Ensure Sync with NRDS is enabled.
  3. Make desired changes.
  4. Click Save. The changes to the supplemental office will immediately be sent to the NRDS processing queue, no further action is required. NOTE: The Save button will not be enabled if any of the required fields are missing.
Change NRDS Status of a Supplemental (Secondary) Office

To change the status of a supplemental office:

  1. For the desired office, click the Realtor tab.
    Office Secondary.jpg
  2. Ensure Sync with NRDS is enabled.
  3. Select the desired status from the NRDS Status list.
  4. Click Save. The changes to the supplemental office will immediately be sent to the NRDS processing queue, no further action is required. NOTE: The Save button will not be enabled if any of the required fields are missing.

Smallest.png

NOTE: All fields listed in Data Sent to NRDS for Supplemental Office will be sent to NRDS.

NRDS Education Records


Every 4 years, in a set cycle, every Realtor and Realtor Associate must take the NAR Code of Ethics course. This Education record can be added by any POE. They do not have to have a primary or secondary relationship with the member. Because members could take an education course at any association, this is the one record that can be added by any POE to any member.

GrowthZone currently provides the ability to track agent's Code of Ethics (COE) training. Synchronization of the education records is made to NRDS within 10 minutes of the addition or update of the records.

Data sent to NRDS for Code of Ethics


The fields described below are sent to NRDS.

Field Name Description Data Format Required
NRDS ID Required. The 9-digit unique member ID of the member. Note: The Member must be active (A or P) or Suspended (S). 9 Numeric X
Education Course Code Required. Unique course code assigned by the sponsoring or licensing association. Once the Group Code has been selected, use this field to enter the specific course code.  


COE Course: For the Code of Ethics course, this should always be COEC. If the POE is entering a new member orientation COE course, it should be COEN
Drop-down choice X
Education Course Number Required. Assigned by the sponsoring or licensing Association.


COE Course: If this is for a COE course, it should always be the year followed by the cycle. 

If the course was in 2012 for Cycle 3, it should be 2012C3. If the course was in 2013 for Cycle 4, it should be 2013C4, etc. 

Several POE reports reply on the Course Number following these standards so always be sure to use this format for the COE course.   

NOTE: if entering the course for new members, using the year as the Course Number is acceptable.
15 Alpha X
Ethics Training Date Date course was completed. For one day courses, use this field for the course date.  COE Course: For the COE course, this should be the date they completed the course. 8 Date  X

Add/Update Code of Ethics Training


Smallest.png

NOTE: The agent must have an NRDS ID and Sync to NRDS must be enabled. NRDS will not allow you to add an Education record for a member who is not active (or Suspended) in NRDS (Status A, P or S).
  1. For the desired agent, click the Realtor's tab.
  2. Enter Code of Ethics details in the Additional Info section.
    Additional Info.jpg
    • Ethics Training Date*
    • Education Course Code*: Select the course from the list.
    • Education Course Number*
    • COE Year*
    • Additional Designations
  3. Click Save.

Your additions/updates to Code of Ethics training will be sent to NRDS within 10 minutes.

NAR ECommerce

ECommerce supports the processing of membership dues splits automatically. When a member pays their dues, GrowthZone will sync with ECommerce to divide the amount according to predefined settings and passes the correct share to each of the local, state, and national associations.

The setup of the ECommerce payment processing account in the GrowthZone software is done by support or an onboarding project manager. The following pieces of information will be needed for setup:

  • Association ID
  • User ID
  • Password

Important Notes

  • GrowthZone only supports splits at the time of payment. For example: You are unable to use ECommerce to process monthly membership payments and then send a lump sum annually to state and national.
  • ECommerce will support up to 6 destination bank accounts, if just one account is being used, the splits will not need to be configured.
  • There are many specific rules & regulations for ECommerce. Please contact NAR with questions.
  • GrowthZone supports creating refunds for memberships that include splits. However, the refund will autodebit ALL of the refunded amount from the local association. This is because NAR does not support autodebitting other associations; it will be up to the local association to contact the others (e.g. State and Nat’l) to recoup those funds. Questions/Concerns should be directed to NAR.
  • For questions about rates and fees, please contact NAR. GrowthZone does not charge additional transaction fees on top of NAR’s fees.

MLS Integration


GrowthZone offers a data integration with various MLS Solutions. This is a push-type integration which sends changes to contact information from GrowthZone to MRED’s MLS vendor, DynaConnections. The sync happens (when there are contact info changes) around 4 times hourly between the hours of 8 am (CST) and 8pm (CST), seven days a week. The purpose of the integration to an MLS is to establish an account for the member, to establish the member's access level within the MLS (defined by the agent's Member Type, and to track the member's status.

Currently, GrowthZone integrates to MRED and Corelogic.

MRED Integration


On initial installation of your software, GrowthZone will configure the initial connection to MRED. You will then be able to manage your agent's participation in MLS from the agent's Real Estate tab. GrowthZone will sync to MRED any additions or changes made to the MLS information on this tab. Records are synchronized every hour.

Data Fields - Agents


The table below describes the fields that are sent to MRED.

Individuals (Agents) Description
NRDS ID The agent NRDS ID
Last Name*
First Name*
Middle Initial
Suffix
Common Name
Title
Address
City
State
Zip/Postal
Home Zip Code
Home Zip +6
Phone (default)
Fax
Cell Phone
MLS Office ID*
Status*
License No
Website
Email
MLS ID*
Agent Type

Data Fields - Offices


The table below describes the fields that are sent to MRED for offices

Sync an Agent to MRED


NOTE: If creating new agents AND a new office, the office must be created first and then the agents assigned to the office.

One Row.png

NOTE: If creating new agents AND a new office, the office must be created first and then the agents assigned to the office.
  1. For the desired agent, verify that all contact information has been populated on the Profile tab. See Agent Data Sent to MRED for details.
  2. Select the agent's Real Estate tab.
  3. Click Enable MLS Sync.
  4. In the MLS section, enter the following information:
    • MLS Office ID: If the contact is an agent, this field should be the MLS ID for the agent's office. If the contact is an office, this field should be the MLS ID of the office, or can be the MLS Id of a parent branch.
    • MLS ID: The MLS ID for this contact (agent or office).
    • MLS Join Date: The date this agent or office became active with MRED.
    • MLS Status: Select Active from the drop-down list. NOTE: The MLS Status is NOT tied to the agent's GrowthZone membership status. Changing membership status will NOT automatically updated the MLS Status.
    • Agent Type: Select the appropriate agent type for this agent. The agent type drives the permissions the agent will have within the MLS. Agent Type is sometimes referred to as "class." When pushed to MLS, this acts as a security role giving/restricting access. Designated Realtors/Broker (DR) are the boss and there can be only 1 per office. Sometimes retired DRS kept in other systems but GZ doesn't support this. Other options are Assocation Staff (AST). Association Admin (ASA), MLS Staff (ST), Personal Assistant (PA), Other Assistant (OS), Office Manager (OM), Licensee, Designated Appraiser (DA), Appraiser (AP), Assistant Appraiser (RAA), Leasing Agent (LA), or Leasing Agent Licensee (LAL).
  5. Click Save.


Below are the fields that are synced with MLS. An asterisk (*) denotes it being a required field; if a required field is not entered/missing in GrowthZone, the sync will fail and information will not be sent to MRED for that contact.

Individuals (Agents) Organizations (Offices)
NRDS ID NRDS ID
Last Name* Office Business Name*
First Name* Address*
Middle Initial City*
Suffix State*
Common Name Zip*
Title Phone (default)
Address Fax
City Type
State Branch Type*
Zip/Postal Status*
Home Zip Code Website
Home Zip +6 Email*
Phone (default) MLD ID*
Fax Status
Cell Phone
MLS Office ID*
Status*
License No
Website
Email
MLS ID*
Agent Type

Important Notes

  • The status field for a contact (office or agent) includes options for Active, Inactive, Terminated and Suspended. From MRED’s point of view, there is no functional difference between Inactive, Terminated and Suspended; the member is denied access. So, you can use these options as appropriate.
  • New MLS IDs must use MRED’s rules for creation. Please contact MRED if you need assistance.
  • Additional status or informational fields may exist in the "More Info" tab, these custom fields are not related to the sync and will not have any effect on the information shared with MLS.
  • MRED only accepts a single phone and a single email address. GrowthZone will synch the email/phone that are indicated as the default.
  • If creating new agents AND a new office, the office must be created first and then the agents assigned to the office.
  • Please contact GrowthZone if you have Commercial MLS members.

Data sent to MRED for an Office


The table below describes the data that is sent to MRED for an office. Ensure that all fields are formatted appropriately, and required fields are populated.

Field Name Description Format Required
 Profile Tab
Name Office Business Name 50 Alpha X
Address 1 Street Number (20 max) and street name (100 max) for the first address that is marked as mailing or physical and mailing.  Must include a street number 120  Alpha X
Address 2 (see above) Office Address Line 2 100 Alpha  
City (see above) Street City 50 Alpha X
State (see above) Street State 2 Alpha X
Postal Code (see above)   5 digit Street ZIP 10 Num X
Postal Code (see above) Street ZIP+6 6 Num  
Phone number Office Phone Number. NOTE: You cannot have a phone without an area code or it will be rejected from MLS 16 Alpha  
Email Address Office E-Mail Address 80 Alpha  
 Real Estate Tab
NRDS ID The office’s 9 digit unique NRDS ID 9 Numeric  
MLS ID Office Tax ID. This is NEVER the same as a NRDS ID 20 Alpha  
MLS Status The office’s MLS status Drop-down list:

Active
Inactive
Suspended

Terminated
X
Office License Number This is the license number for the office from the State.    
MLS Join Date The date the office began with the MLS 8 Date  
MLS Term Date Date of termination of agent/office with MLS provider 8 Date  

Corelogic Matrix Integration


CoreLogic's MATRIX MLS is an MLS system that is a leader in this space. GrowthZone is responsible for setting up members/agents in the MLS along with their security level. From that point, we would send updated information on their member profile. CoreLogic REQUIRES testing with each new customer before we go live.

Lockbox


Sentrilock


GrowthZone offers a data integration with SentriLock’s lockbox solution. The purpose of the synchronization to Sentri-lock is to activate an account for an office or agent, and define the security level afforded that office or agent. The sync happens in real time with updates appearing SentriLock in a matter of minutes. On the Real Estate tab of a contact, there is a "Sync with Lockbox" checkbox that needs to be ticked in order for the system to recognize the sync option. When enabled, GrowthZone will send updates to SentriLock whenever contact information is updated or entered new.

Sentrilock - Initial Integration Setup


The GrowthZone team will setup initial integration to Sentrilock, with your input. During this process you will decide the following:

  • What to use for the Lockbox Office Id Source: You will choose from NRDS ID, MLS ID or Custom. If NRDS or MLS are selected, the system will automatically use these ID’s and prompt you if these ID’s are not set. If you select Custom, you will populate your own unique ID each time you activate an agent or office with Sentrilock.
  • What to use for the Lockbox User Name Source: You will choose from NRDS ID, MLS ID or Custom. If NRDS or MLS are selected, the system will automatically use these ID’s and prompt you if these ID’s are not set. If you select Custom, you will populate your own unique ID each time you activate an agent or office with Sentrilock.
  • What to use for the Lockbox External Id Source: You will choose NRDS ID, MLS ID or Custom. If NRDS or MLS are selected, the system will automatically use these ID’s and prompt you if these ID’s are not set. If you select Custom, you will populate your own unique ID each time you activate an agent or office with Sentrilock.
  • Will you “Use Membership Status To Determine Lockbox Status”: If you choose this option, LockBox Member Status will automatically be updated, based on the status of the membership with your association. For example, if an agent has an active membership with your association, and a valid Sentrilock status, when you drop that member, the Sentrilock status will automatically be updated to Terminated.

Sentrilock - Working with Agents


You can add new accounts for, and change those accounts from the GrowthZone software.

Sentrilock - Agent Data


The data described in the table below is synchronized to Sentrilock. An asterisk indicates a required field. Each time data is sent to Sentrilock, All data is sent, not just the fields that you changed.


Sentrilock - Office Data


Below are the fields that are synced with SentriLock. An asterisk (*) denotes it being a required field; if a required field is not entered/missing in GrowthZone, the sync will fail and information will not be sent to SentriLock for that contact.

SentriLock Data Sync Fields
First Name*
Last Name*
Address
City
State
Zip/Postal
Email*
Phone
MLS ID*
MLS Office ID*
NRDS ID* (required as of January, 2019)
Related Org*
Password
Status*

Important Notes

  • SentriLock only accepts a single phone and a single email address. GrowthZone will send the email/phone marked as default.
  • Additional status or informational fields may exist in the "More Info" tab, these custom fields are not related to the sync and will not have any effect on the information shared with SentriLock.
  • The Password field should be used only when creating a new user. This is meant to make it easier to create a new SentriLock account by entering a temporary “starter” password for the new member. The new agent should be advised to login to SentriLock and change this to a personal password. After the password is saved, it will be encrypted for security purposes. This will display in the password field, however, it will be a random strings of characters, it may be ignored as the password has then been encrypted.

Supra


Supra has provided keyboxes to the real estate industry since 1955, bringing efficiency to real estate professionals and peace of mind to home sellers. By integration with GrowthZone, you are able to setup accounts for your agents/office each has to access a lock-box. In addition to activating new accounts with Supra, you will also be able to change the account, and importantly terminate accounts when needed.

Data Synchronized to Supra


The table below describes the data that is synchronized with Supra. Hourly, your GrowthZone system will look for additions or changes to Supra Data. If there have been any, all of the information in the table below is sent.

Field Name Description Data format Required
Profile Tab      
Last Name Last name of agent 21 Alpha X
First Name First name of agent 17 Alpha X
Middle Middle initial of the agent 3 Alpha  
City (primary) City 31 Alpha X
State (primary) State 2 Alpha X
Phone (primary) Area code of & phone number of agent's phone number 23 Numeric  
Address 1 (primary) First line of agent's address line 35 Alpha  
Address 2 (primary) Second office address line 35 Alpha  
Zip (primary) Zip code of agent address 11 Alpha  
Country (primary) Country 4 Alpha  
Fax Number (primary) Area code  & Phone number of agent's fax number marked as primary 23 Alpha  
Email (primary) Email marked as primary 64 Alpha  
Real Estate Tab
Lock Box Agent ID   Unique Agent ID

During initial setup with GrowthZone you may chose this to be one of the following:

  • Agent NRDS ID
  • Agent MLS ID
  • Office NRDS ID
  • Office MLS ID
  • Custom – an ID of your choice
15 Alpha X
Lock Box Member Status Agent Status – Active, Hold, Inactive Drop-down choice X
LockBox Listing Agent ID Listing Agent ID

During initial setup with GrowthZone you may chose this to be one of the following:

  • Agent NRDS ID
  • Agent MLS ID
  • Office NRDS ID
  • Office MLS ID
  • Custom – an ID of your choice
32 Alpha X
LockBox Office ID Office ID

During initial setup with GrowthZone you may chose this to be one of the following:

  • Agent NRDS ID
  • Agent MLS ID
  • Office NRDS ID
  • Office MLS ID
  • Custom – an ID of your choice
   

Initial Integration Setup for Supra LockBox


GrowthZone will perform the initial setup for your Supra Integration. During this process you will have defined, the following:

  • What to use for the Lock Box Agent ID: You will choose NRDS ID, MLS ID or Custom. If NRDS or MLS are selected, the system will automatically use these ID’s and prompt you if these ID’s are not set. If you select Custom, you will populate your own unique ID each time you activate an agent or office with Supra.
  • What to use for the Lock Box Office ID: You will choose NRDS ID, MLS ID or Custom. If NRDS or MLS are selected, the system will automatically use these ID’s and prompt you if these ID’s are not set. If you select Custom, you will populate your own unique ID each time you activate an agent or office with Supra.
  • What to use for the Lockbox Listing Agent ID: You will choose NRDS ID, MLS ID or Custom. If NRDS or MLS are selected, the system will automatically use these ID’s and prompt you if these ID’s are not set. If you select Custom, you will populate your own unique ID each time you activate an agent or office with Supra.
  • Whether you will enable “Use Membership Status To Determine Lockbox Status”: If you choose this option, LockBox Member Status will automatically be updated, based on the status of the membership with your association. For example, if an agent has an active membership with your association, and a valid LockBox status, when you drop that member, the LockBox status will automatically be updated to Terminated. Conversely, if you re-activate an agent, the LockBox status will be updated to Valid. NOTE: This functionality will only work if there is only one membership associated to the agent.

Supra - Working with Agents


Activate an Agent’s Supra Account

  1. On the Agent’s Profile tab, ensure that all required information, defined in Data Synchronized to Supra, above, has been populated.
  2. Click the Real Estate tab.
    Real estate tab1.jpg
  3. Click Sync With LockBox
  4. In the LockBox section, select Valid from the LockBox Member Status list.
    Lock Box Settings.jpg
  5. Additional fields that will need to be populated in the LockBox section will vary dependent on your integration settings.
    • If you have selected Custom for the Lock Box Office ID, Lock Box Agent ID and Lock Box Listing ID, enter your custom identifiers.
    • If you have selected NRDS ID or MLS ID, ensure these fields are populated on the Real Estate tab. You will not be able to save the record, and therefore synchronize to Supra if they are not.
  6. Click Save.
Change an Agent’s Supra Account Record

Any changes made the fields described in Data Synchronized to Supra, above, will result in a change record being sent to Supra. As long a Sync to LockBox is enabled, the system will “notice” these changes and send them within the hour, with no interaction on your part.

Terminate an Agent’s Supra Account Record

  1. On the Agent’s Profile tab, ensure that all required information, defined in Data Synchronized to Supra, above, has been populated.
  2. Click the Real Estate tab.
    Real estate tab1.jpg
  3. Ensure that Sync With LockBox is checked.
  4. In the LockBox section, select Terminated from the LockBox Member Status list.
    Lockbox terminated.jpg
  5. Click Save.

One Row.png

NOTE: If your system is configured to Use Membership Status To Determine Lockbox Status, dropping an agent's membership to your association, will also result in the LockBox Member Status being set to Terminated. This option is only available if you have one and only one association membership type per agent.
Suspend an Agent’s Supra Account Record

  1. On the Agent’s Profile tab, ensure that all required information, defined in Data Synchronized to Supra, above, has been populated.
  2. Click the Real Estate tab.
    Real estate tab1.jpg
  3. Ensure that Sync With LockBox is checked.
  4. In the LockBox section, select Terminated from the LockBox Member Status list.
    Lockbox suspended.jpg
  5. Click Save.
Disable Synchronization of an Individual Agent to Supra

Any additions or changes to an agent's record, will automatically be synchronized to Supra. You can disable this for an individual agent, if needed:

  1. On the Agent’s the Real Estate tab, deselect Sync With LockBox.
    Real estate tab1.jpg
  2. Click Save.

Deselecting this will NOT remove the contact's data from Supra, it will simply stop the updates to the record from being sent.

Supra - Working with Offices


Activate an Office's Supra Account

  1. On the Office's Profile tab, ensure that all required information, defined in Data Synchronized to Supra, above, has been populated.
  2. Click the Real Estate tab.
    Office Lockbox.jpg
  3. Click Sync with Lockbox.
  4. In the LockBox section, select Valid from the LockBox Member Status list.
  5. The fields that will need to be populated in the LockBox section will vary dependent on your integration settings.
    • If you have selected Custom for the Lock Box Office ID, enter this office’s unique ID
    • If you have selected NRDS ID or MLS ID for your LoxkBox Office Id in the integration settings, ensure these fields are populated on the Real Estate tab. You will not be able to save the record, and therefore synchronize to Supra, if they are not.
  6. Click Save.
Terminate an Office’s Supra Account

  1. On the Office’s Profile tab, ensure that all required information, defined in Data Synchronized to Supra, above, has been populated.
  2. Click the Real Estate tab
  3. Ensure Sync With LockBox is enabled.
    Office Lockbox.jpg
  4. In the LockBox section, select Terminate from the LockBox Member Status list.
  5. Click Save.

One Row.png

IMPORTANT If an Office’s LockBox Supra Account is Terminated, all agent’s associated to this office will also be “locked out” of LockBox.
Suspend an Office’s Supra Account

  1. On the Office’s Profile tab, ensure that all required information, defined in Data Synchronized to Supra, above, has been populated.
  2. Click the Real Estate tab
  3. Ensure Sync With LockBox is enabled.
    Office Lockbox.jpg
  4. In the LockBox section, select Suspend from the LockBox Member Status list.
  5. Click Save.
Change an Office’s Supra Account Record

Any changes made the fields described in Data Synchronized to Supra, will result in a change record being sent to Supra. As long as Sync to LockBox is enabled, the system will “notice” these changes and send them within the hour, with no interaction on your part.

Smallest.png

NOTE: All fields are sent to Supra, not just those that have changed.
Disable Synchronization of an Individual Office to Supra

Any additions or changes to an Office's record, will automatically be synchronized to Supra. You can disable this for an individual office, if needed:

  1. On the Office’s the Real Estate tab, deselect Sync With LockBox.
  2. Click Save.

Deselecting this will NOT remove the office's data from Supra, it will simply stop the updates to the record from being sent from GrowthZone.

GrowthZone APIs


Using the GrowthZone APIs is a way to easily integrate your GrowthZone data into other systems. Examples may include incorporating content like directories, events, etc. into a CMS, creating an SSO with your website or another application, or tying a mobile app to your GrowthZonedatabase. The API is a standard REST-based API with the ability to access many areas of the software.

Click Here to view a full list of available GrowthZone APIs. GrowthZone's APIs are under active development and changes or additions can occur. This documentation is updated regularly and always represents the current state. APIs in GrowthZone are broadly organized by areas of use (i.e. modules).

One Row.png

NOTE: In order to begin making calls to GrowthZone, you will need to first have API access enabled in your tenant and obtain an API Client ID and Secret. For authentication options, we currently support standard oAuth2 flows and SAML. If you have questions or need help regarding API authentication, integration or support, please call 800.825.9171 or email support@growthzone.com.