Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Contacts: Portal/VOW Accounts

The Portal account sub-service provides access to consumer account information. These accounts are automatically created when a contact is created or edited, but older contacts may not yet have a corresponding consumer account.

  1. Supported Roles
  2. Available Services
    1. Portal Account
  3. Response Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes Yes Writes allowed for portal creation only
Public Yes No
VOW Yes No
Portal Yes No
Private Yes Yes

More information about roles may be found here.

 

Available Services

Portal Account

/<API Version>/contacts/<Contact.Id>/portal

HTTP Method Description Notes
GET Returns account information for the current user  
POST Creates a consumer account  
PUT Updates a consumer account  
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

No parameters

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results: [{
            "ResourceUri": "/vX/contacts/201010122342756895000000/portal",
            "Id": "20060412165917817933000000",
            "OwnerId": "20090410349683017933000000",
            "LoginName": "dave",
            "LastActive": "2012-03-07T21:13:11Z",
            "Locale": {
              "Language": "en"
            },
            "Identity": {
              "Connected": true,
              "Email": "dave_meyer@mailinator.com"
            },
            "Messages": {
              "EmailNotificationsEnabled": true
            },
            "Enabled": true
        }]
    }
}
 

POST Request

{
    "D": {
        "LoginName": "Johnny Everyman",
        "Password": "MyPassw0rd",
        "Settings": {
            "Enabled": true
        },
        "Locale": {
          "Language": "en"
        }
  }
}

POST Response

The standard success/fail response is returned.

PUT Request

All fields used in the POST request may be used in a PUT request.

{
        "Password": "ANewPassw3rd",
        "Settings": {
            "Enabled": false,
        },
        "Messages": {
          "EmailNotificationsEnabled": true
        }
  }
}
 

PUT Response

The standard success/fail response is returned.

 

Response Description

Attribute Data Type Writeable Required Description
LastActive Timestamp No No The last date and time the Portal user was active in the agent's portal. Note: this is only accurate to the hour, as the timestamp is updated at most once per hour.
LastLogin Timestamp No No (Deprecated in favor of LastActive).The last date and time the Portal user logged in to the agent's portal. If null, the Portal user has never logged in to their account.
LoginName Character Yes No If not provided, the contact's PrimaryEmail will be used as the login name.
Password Character Yes No If not provided, a password will be created and sent back in the response. For security reasons, GET requests will not return the password
Identity.Connected Boolean No No If true, the Portal account for your contact has been linked to a consumer's flexmls Web account. Agents are linked to consumers by privileged applications using the Consumers: Agents service.
Identity.Email Boolean No No If connected, will populate the email used for the linked consumer account.
Locale.Language Character Yes No The code for the user's preferred language. Consult the System Info: Languages service for supported languages, which may vary per MLS.
Messages.EmailNotificationsEnabled Boolean Yes No If true the consumer will recieve email notifications for messages.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.