Alpha Only: This service is subject to change
This service is a work in progress. It is currently subject to change or removal without notice.

Portal Groups

These groups of Contact VOW/Portal Accounts that share resources such as Listing Carts, News Feeds and Saved Searches. All portal groups share an Id with a single VOW/Portal Account in the group, which is the portal group owner. All shared carts, searches and news feeds belong to this VOW/Portal account.

Accessing Resources "As Portal Group"
You'll notice that the Supported Roles section for resources such as Listing Carts have Role column text for the VOW and Portal roles that reads "Portal (As Portal Group)". Remember that, for these services, users accessing the API with a VOW or Portal role will access the data that belongs to their Current Portal Group owner.
Referencing Portal Groups by Portal.Id
Portal Groups are identified by the Portal.Id for the lead VOW/Portal user. All members of a group must have a VOW/Portal Account, especially the group owner. Use that service to set up new Portal accounts for consumers prior to managing groups. See a walkthrough for setting up a portal and contact Portal accounts here.
  1. Supported Roles
  2. Available Services
    1. All Portal Groups
    2. Individual Portal Group
    3. Portal Group Member
  3. Portal Groups Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW Yes No
Portal Yes No
Private Yes Yes
More information about roles may be found here.

Available Services

All Portal Groups

URI: /<API Version>/portal/groups

HTTP Method Description Conditional Notes
GET Returns all portal groups, ordered by the primary contact's Name. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Standard search and paging syntax Yes

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
             "Id": "20120212214851732931000000",
             "ResourceUri": "/v1/portal/groups/20120212214851732931000000",
             "ContactId": "20120112234853732441000000",
             "Tags": ["Favorites"],
             "Users": [
                  {
                    "Id": "20110112234857732941000000",
                    "ResourceUri": "/v1/contacts/20110112234857732941000000",
                    "UserType": "Contact",
                    "Name": "Carl Contact",
                    "OfficeId": null,
                    "Office": null,
                    "CompanyId": null,
                    "Company": null
                  }
             ]
          }
       ]
    }
}

Individual Portal Group

URI: /<API Version>/portal/groups/<Portal.Id>

HTTP Method Description Conditional Notes
GET Returns the information and user list for a portal group. No
POST Adds additional portal accounts to the group. No
PUT Replaces the list of portal users and/or update Tags. No
DELETE Destroys the group relationship. No

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the activities service.

POST Request

Request body:
{
    "D": {
        "Users": [
            {
                "Id": "20100000000000000000000000"
            }
        ]
    }
}

POST Response

The standard success/fail response is returned.

PUT Request

Request body:
{
    "D": {
        "Users": [
            {
                "Id": "20100000000000000000000000"
            }
        ],
        "Tags": ["Favorites"]
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Available Services

Portal Group Member

URI: /<API Version>/portal/groups/<Portal.Id>/users/<PortalUser.Id>

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Removes a user from the portal group. No

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Portal Groups Description

Attribute Data Type Writeable Required Searchable Description
Id Character No The unique ID for the portal. This will be identical to the primary portal user's VOW/Portal Account Id.
ResourceUri Character No The URI to the portal group.
ContactId Character No The Id for the Contact record associated with the primary portal user.
Tags Character List No An array of Tags associated with a portal group. Currently, the only supported tag is Favorites.
Users Expansion A list of Contact records that are part of this circle.
Id Character No The unique ID for the contact.
ResourceUri Character No The URI to the contact record.
Active Boolean Yes If true, the Contact has an active Portal and has been active in the past 30 days. Applies to the Contact UserType only.
Enabled Boolean No If false, the Contact has a disabled VOW/Portal account.
Name Character Yes The name of the user. Only the name of the Portal Group owner (specified by ContactId) is searchable.
LastLogin Timestamp No When the contact last signed in to their portal. Applies to the Contact UserType only.
UserType Character No In addition to the values available in the accounts service, the value may include Contact.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.