ActivityParty Entity Reference

Person or group associated with an activity. An activity can have multiple activity parties.

Messages

Message Web API Operation SDK Assembly
RetrieveMultiple GET [org URI]/api/data/v9.0/activityparties
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Entity Properties

Property Value
CollectionSchemaName ActivityParties
DisplayCollectionName Activity Parties
DisplayName Activity Party
EntitySetName activityparties
IsBPFEntity False
LogicalCollectionName activityparties
LogicalName activityparty
OwnershipType None
PrimaryIdAttribute activitypartyid
PrimaryNameAttribute partyidname
SchemaName ActivityParty

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ActivityId

Property Value
Description Unique identifier of the activity associated with the activity party. (A "party" is any person who is associated with an activity.)
DisplayName Activity
IsValidForForm False
IsValidForRead True
LogicalName activityid
RequiredLevel SystemRequired
Targets activitypointer
Type Lookup

ActivityPartyId

Property Value
Description Unique identifier of the activity party.
DisplayName Activity Party
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName activitypartyid
RequiredLevel SystemRequired
Type Uniqueidentifier

AddressUsed

Property Value
Description Email address to which an email is delivered, and which is associated with the target entity.
DisplayName Address
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName addressused
MaxLength 200
RequiredLevel None
Type String

Effort

Property Value
Description Amount of effort used by the resource in a service appointment activity.
DisplayName Effort
IsValidForForm False
IsValidForRead True
LogicalName effort
MaxValue 1000000000
MinValue 0
Precision 2
RequiredLevel None
Type Double

ExchangeEntryId

Property Value
Description For internal use only.
DisplayName Exchange Entry
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName exchangeentryid
MaxLength 1024
RequiredLevel None
Type String

ParticipationTypeMask

Property Value
Description Role of the person in the activity, such as sender, to, cc, bcc, required, optional, organizer, regarding, or owner.
DisplayName Participation Type
IsValidForForm False
IsValidForRead True
LogicalName participationtypemask
RequiredLevel SystemRequired
Type Picklist

ParticipationTypeMask Options

Value Label
1 Sender
2 To Recipient
3 CC Recipient
4 BCC Recipient
5 Required attendee
6 Optional attendee
7 Organizer
8 Regarding
9 Owner
10 Resource
11 Customer

PartyId

Property Value
Description Unique identifier of the party associated with the activity.
DisplayName Party
IsValidForForm False
IsValidForRead True
LogicalName partyid
RequiredLevel None
Targets account,contact,knowledgearticle,queue,systemuser
Type Lookup

PartyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName partyidname
MaxLength 400
RequiredLevel None
Type String

PartyObjectTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName partyobjecttypecode
RequiredLevel SystemRequired
Type EntityName

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

AddressUsedEmailColumnNumber

Property Value
Description Email address column number from associated party.
DisplayName Email column number of party
Format None
IsValidForForm False
IsValidForRead True
LogicalName addressusedemailcolumnnumber
MaxValue 2147483647
MinValue 1
RequiredLevel None
Type Integer

DoNotEmail

Property Value
Description Information about whether to allow sending email to the activity party.
DisplayName Do not allow Emails
IsValidForForm False
IsValidForRead True
LogicalName donotemail
RequiredLevel None
Type Boolean

DoNotEmail Options

Value Label
1 Do Not Allow
0 Allow

DefaultValue: False

DoNotFax

Property Value
Description Information about whether to allow sending faxes to the activity party.
DisplayName Do not allow Faxes
IsValidForForm False
IsValidForRead True
LogicalName donotfax
RequiredLevel None
Type Boolean

DoNotFax Options

Value Label
1 Do Not Allow
0 Allow

DefaultValue: False

DoNotPhone

Property Value
Description Information about whether to allow phone calls to the lead.
DisplayName Do not allow Phone Calls
IsValidForForm False
IsValidForRead True
LogicalName donotphone
RequiredLevel None
Type Boolean

DoNotPhone Options

Value Label
1 Do Not Allow
0 Allow

DefaultValue: False

DoNotPostalMail

Property Value
Description Information about whether to allow sending postal mail to the lead.
DisplayName Do not allow Postal Mails
IsValidForForm False
IsValidForRead True
LogicalName donotpostalmail
RequiredLevel None
Type Boolean

DoNotPostalMail Options

Value Label
1 Do Not Allow
0 Allow

DefaultValue: False

InstanceTypeCode

Property Value
Description Type of instance of a recurring series.
DisplayName Appointment Type
IsValidForForm False
IsValidForRead True
LogicalName instancetypecode
RequiredLevel SystemRequired
Type Picklist

InstanceTypeCode Options

Value Label
0 Not Recurring
1 Recurring Master
2 Recurring Instance
3 Recurring Exception
4 Recurring Future Exception

IsPartyDeleted

Property Value
Description Information about whether the underlying entity record is deleted.
DisplayName Is Party Deleted
IsValidForForm False
IsValidForRead True
LogicalName ispartydeleted
RequiredLevel SystemRequired
Type Boolean

IsPartyDeleted Options

Value Label
1 Yes
0 No

DefaultValue: False

OwnerId

Property Value
Description Unique identifier of the user or team who owns the activity_party.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel ApplicationRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead False
LogicalName owningbusinessunit
RequiredLevel None
Type Uniqueidentifier

OwningUser

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead False
LogicalName owninguser
RequiredLevel None
Type Uniqueidentifier

ScheduledEnd

Property Value
DateTimeBehavior UserLocal
Description Scheduled end time of the activity.
DisplayName Scheduled End
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName scheduledend
RequiredLevel None
Type DateTime

ScheduledStart

Property Value
DateTimeBehavior UserLocal
Description Scheduled start time of the activity.
DisplayName Scheduled Start
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName scheduledstart
RequiredLevel None
Type DateTime

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

ActivityParty_SyncErrors

Same as syncerror entity ActivityParty_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName ActivityParty_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

account_activity_parties

See account Entity account_activity_parties One-To-Many relationship.

letter_activity_parties

See letter Entity letter_activity_parties One-To-Many relationship.

phonecall_activity_parties

See phonecall Entity phonecall_activity_parties One-To-Many relationship.

task_activity_parties

See task Entity task_activity_parties One-To-Many relationship.

recurringappointmentmaster_activity_parties

See recurringappointmentmaster Entity recurringappointmentmaster_activity_parties One-To-Many relationship.

contact_activity_parties

See contact Entity contact_activity_parties One-To-Many relationship.

system_user_activity_parties

See systemuser Entity system_user_activity_parties One-To-Many relationship.

appointment_activity_parties

See appointment Entity appointment_activity_parties One-To-Many relationship.

socialactivity_activity_parties

See socialactivity Entity socialactivity_activity_parties One-To-Many relationship.

queue_activity_parties

See queue Entity queue_activity_parties One-To-Many relationship.

knowledgearticle_activity_parties

See knowledgearticle Entity knowledgearticle_activity_parties One-To-Many relationship.

email_activity_parties

See email Entity email_activity_parties One-To-Many relationship.

fax_activity_parties

See fax Entity fax_activity_parties One-To-Many relationship.

activitypointer_activity_parties

See activitypointer Entity activitypointer_activity_parties One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
activityparty EntityType