ParticipantRole

Represents details, such as the name and associated default access level, for a role that a participant can have in the context of a parent record.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Note

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ParticipantRole components have the suffix .participantRole and are stored in the participantRoles folder.

Version

ParticipantRole components are available in API version 50.0 and later.

Fields

Field Name	Description
defaultAccessLevel	Field Type picklist Description Required. The default sharing access granted to the participant role. Valid values are: `Edit`—Read/Write `None` `Read`—Read Only
isActive	Field Type boolean Description Indicates whether the participant role is activated.
masterLabel	Field Type string Description Required. The name for the participant role.
parentObject	Field Type string Description Required. The parent object for the participant role. Valid values are: `Account` `Budget` Available in API version 59.0 and later. `IndividualApplication` Available in API version 59.0 and later. `Interaction` Available in API version 52.0 and later. `InteractionSummary` Available in API version 51.0 and later. `FinancialDeal` Available in API version 52.0 and later. `FundingAward` Available in API version 59.0 and later. `FundingOpportunity` `Opportunity` `Team` Available in API version 58.0 and later. Custom objects

Declarative Metadata Sample Definition

The following is an example of a ParticipantRole component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ParticipantRole xmlns="http://soap.sforce.com/2006/04/metadata">
3    <defaultAccessLevel>Read</defaultAccessLevel>
4    <isActive>true</isActive>
5    <masterLabel>Advisor</masterLabel>
6    <parentObject>Account</parentObject>
7</ParticipantRole>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ParticipantRole</name>
6    </types>
7    <version>50.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide