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. This object is available in API version 50.0 and later.

Supported Calls

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

Fields

DefaultAccessLevel

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The default sharing access granted to the participant role.
  • Possible values:
    • Edit—Read/Write
    • None
    • Read—Read Only

DeveloperName

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The unique name of the object in the API.

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the participant role is activated (true) or not (false).

Language

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The language of the participant role.

MasterLabel

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name for the participant role.

NamespacePrefix

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Namespace prefix associated with this object.

ParentObject

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The parent object for the participant role.
  • Possible values:
    • Account
    • InteractionSummary—Available in API version 51.0 and later.

    • Opportunity