activityparty EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/activityparties
Base Type
crmbaseentity
Display Name
Activity Party
Primary Key
activitypartyid
Primary Key Attribute
partyidname
Operations Supported
GET (RetrieveMultiple Only)

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
activitypartyid Edm.Guid

Unique identifier of the activity party.

Display Name: Activity Party

addressused Edm.String

Email address to which an email is delivered, and which is associated with the target entity.

Display Name: Address

addressusedemailcolumnnumber Edm.Int32

Email address column number from associated party.

Display Name: Email column number of party

Read Only
donotemail Edm.Boolean

Information about whether to allow sending email to the activity party.

Display Name: Do not allow Emails

Read Only
Default Options
Value Label
1 Do Not Allow
0 Allow
donotfax Edm.Boolean

Information about whether to allow sending faxes to the activity party.

Display Name: Do not allow Faxes

Read Only
Default Options
Value Label
1 Do Not Allow
0 Allow
donotphone Edm.Boolean

Information about whether to allow phone calls to the lead.

Display Name: Do not allow Phone Calls

Read Only
Default Options
Value Label
1 Do Not Allow
0 Allow
donotpostalmail Edm.Boolean

Information about whether to allow sending postal mail to the lead.

Display Name: Do not allow Postal Mails

Read Only
Default Options
Value Label
1 Do Not Allow
0 Allow
effort Edm.Double

Amount of effort used by the resource in a service appointment activity.

Display Name: Effort

exchangeentryid Edm.String

For internal use only.

Display Name: Exchange Entry

instancetypecode Edm.Int32

Type of instance of a recurring series.

Display Name: Appointment Type

Read Only
Default Options
Value Label
0 Not Recurring
1 Recurring Master
2 Recurring Instance
3 Recurring Exception
4 Recurring Future Exception
ispartydeleted Edm.Boolean

Information about whether the underlying entity record is deleted.

Display Name: Is Party Deleted

Read Only
Default Options
Value Label
1 Yes
0 No
participationtypemask Edm.Int32

Role of the person in the activity, such as sender, to, cc, bcc, required, optional, organizer, regarding, or owner.

Display Name: Participation Type

Default 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
scheduledend Edm.DateTimeOffset

Scheduled end time of the activity.

Display Name: Scheduled End

Read Only
scheduledstart Edm.DateTimeOffset

Scheduled start time of the activity.

Display Name: Scheduled Start

Read Only
versionnumber Edm.Int64
Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_activityid_value activityid_activitypointer

Unique identifier of the activity associated with the activity party. (A "party" is any person who is associated with an activity.)

_ownerid_value activityid_activitypointer

Unique identifier of the user or team who owns the activity_party.

_partyid_value partyid_queuepartyid_systemuserpartyid_knowledgearticlepartyid_accountpartyid_contact

Unique identifier of the party associated with the activity.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
activityid_activitypointer activitypointer activitypointer_activity_parties
activityid_appointment appointment appointment_activity_parties
activityid_email email email_activity_parties
activityid_fax fax fax_activity_parties
activityid_letter letter letter_activity_parties
activityid_phonecall phonecall phonecall_activity_parties
activityid_recurringappointmentmaster recurringappointmentmaster recurringappointmentmaster_activity_parties
activityid_socialactivity socialactivity socialactivity_activity_parties
activityid_task task task_activity_parties
partyid_account account account_activity_parties
partyid_contact contact contact_activity_parties
partyid_knowledgearticle knowledgearticle knowledgearticle_activity_parties
partyid_queue queue queue_activity_parties
partyid_systemuser systemuser system_user_activity_parties

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
ActivityParty_SyncErrors syncerror regardingobjectid_activityparty_syncerror

See also