Newer Version Available

This content describes an older version of this product. View Latest

NetworkAffinity

Represents a junction object that associates a user profile with a Network object, that is, with a community. Use NetworkAffinity to assign a default community to a user profile. This object is available in API version 41.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

To work with the NetworkAffinity object, you must have View Setup or Customize Application permission.

Fields

Field Name Details
NetworkId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the default community associated with a user profile.
ProfileId
Type
reference
Properties
CreateFilter, Group, Sort, Update
Description
ID of the user profile the default community is assigned to.

Usage

Use the NetworkAffinity object to assign a default community to a user profile. The default community enables you to stamp network-agnostic email notifications to all users with that profile with the selected community's branding. The default community also becomes the target destination for email notification links. Network-agnostic email notifications include notifications about records, like cases, accounts, and opportunities.

The NetworkId field is not updatable through the API in Workbench, Apex, or SOAP. If you want to change the value for NetworkId, you must delete the record and create one with the right value.