---
schema_version: "1"
id: 700327f8491483fbcb8bff3678f978c1c0c332a47e051e313528b0a95461fe4c
title: ParticipantRole
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/fsc_meta_participantrole.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/fsc_meta_participantrole.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 02fbd7b4df1e247b0f463e317606952539efc185ec87765247356fea55d63e88
description: 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.
---
# 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.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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.

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

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>ParticipantRole</name\>
    </types\>
    <version\>50.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").