letter EntityType

Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.

Entity Set Path
[organization URI]/api/data/v9.0/letters
Base Type
Display Name
Primary Key
Primary Key Attribute
Operations Supported


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

Name Type Details
activityadditionalparams Edm.String

Additional information provided by the external application as JSON. For internal use only.

activityid Edm.Guid

Unique identifier of the activity.

Display Name: Letter

activitytypecode Edm.String

Type of activity.

Display Name: Activity Type

Read Only
actualdurationminutes Edm.Int32

Actual duration of the activity in minutes.

Display Name: Duration

actualend Edm.DateTimeOffset

Actual end time of the activity.

Display Name: Actual End

actualstart Edm.DateTimeOffset

Actual start time of the activity.

Display Name: Actual Start

address Edm.String

Type the complete recipient address for the letter to ensure timely delivery.

Display Name: Address

category Edm.String

Type a category to identify the letter type, such as sales offer or past due notice, to tie the letter to a business group or function.

Display Name: Category

community Edm.Int32

Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only.

createdon Edm.DateTimeOffset

Date and time when the activity was created.

Display Name: Created On

Read Only
deliverylastattemptedon Edm.DateTimeOffset

Date and time when the delivery of the activity was last attempted.

Read Only
deliveryprioritycode Edm.Int32

Priority of delivery of the activity to the email server.

description Edm.String

Description of the activity.

Display Name: Description

directioncode Edm.Boolean

Select the direction of the letter as incoming or outbound.

Display Name: Direction

Default Options
Value Label
1 Outgoing
0 Incoming
exchangeitemid Edm.String

The message id of activity which is returned from Exchange Server.

exchangerate Edm.Decimal

Exchange rate for the currency associated with the activitypointer with respect to the base currency.

Display Name: Exchange Rate

Read Only
exchangeweblink Edm.String

Shows the web link of Activity of type email.

importsequencenumber Edm.Int32

Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

instancetypecode Edm.Int32

Type of instance of a recurring series.

Read Only
isbilled Edm.Boolean

Information regarding whether the activity was billed as part of resolving a case.

Display Name: Is Billed

Default Options
Value Label
1 Yes
0 No
ismapiprivate Edm.Boolean

For internal use only.

isregularactivity Edm.Boolean

Information regarding whether the activity is a regular activity type or event type.

Display Name: Is Regular Activity

Read Only
Default Options
Value Label
1 Yes
0 No
isworkflowcreated Edm.Boolean

Information regarding whether the activity was created from a workflow rule.

Display Name: Is Workflow Created

Default Options
Value Label
1 Yes
0 No
lastonholdtime Edm.DateTimeOffset

Contains the date and time stamp of the last on hold time.

Display Name: Last On Hold Time

leftvoicemail Edm.Boolean

Left the voice mail

modifiedon Edm.DateTimeOffset

Date and time when activity was last modified.

Display Name: Modified On

Read Only
onholdtime Edm.Int32

Shows how long, in minutes, that the record was on hold.

Display Name: On Hold Time (Minutes)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

postponeactivityprocessinguntil Edm.DateTimeOffset

For internal use only.

Read Only
prioritycode Edm.Int32

Priority of the activity.

Display Name: Priority

Default Options
Value Label
0 Low
1 Normal
2 High
processid Edm.Guid

Unique identifier of the Process.

Display Name: Process

scheduleddurationminutes Edm.Int32

Scheduled duration of the activity, specified in minutes.

Display Name: Scheduled Duration

scheduledend Edm.DateTimeOffset

Scheduled end time of the activity.

Display Name: Due Date

scheduledstart Edm.DateTimeOffset

Scheduled start time of the activity.

Display Name: Start Date

senton Edm.DateTimeOffset

Date and time when the activity was sent.

Read Only
seriesid Edm.Guid

Uniqueidentifier specifying the id of recurring series of an instance.

Read Only
sortdate Edm.DateTimeOffset

Shows the date and time by which the activities are sorted.

Display Name: Sort Date

stageid Edm.Guid

Unique identifier of the Stage.

Display Name: (Deprecated) Process Stage

statecode Edm.Int32

Status of the activity.

Display Name: Activity Status

Default Options
Value Label
0 Open
1 Completed
2 Canceled
statuscode Edm.Int32

Reason for the status of the activity.

Display Name: Status Reason

Default Options
Value Label
1 Open
2 Draft
3 Received
4 Sent
5 Canceled
subcategory Edm.String

Type a subcategory to identify the letter type and relate the activity to a specific product, sales region, business group, or other function.

Display Name: Sub-Category

subject Edm.String

Subject associated with the activity.

Display Name: Subject

subscriptionid Edm.Guid

For internal use only.

Display Name: Subscription

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

traversedpath Edm.String

For internal use only.

Display Name: (Deprecated) Traversed Path

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the activity.

Display Name: Version Number

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

Unique identifier of the user who created the activity.


Unique identifier of the delegate user who created the activitypointer.


Unique identifier of user who last modified the activity.


Unique identifier of the delegate user who last modified the activitypointer.


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


Unique identifier of the business unit that owns the activity.


Unique identifier of the team that owns the activity.


Unique identifier of the user that owns the activity.


Unique identifier of the object with which the activity is associated.


Unique identifier of the mailbox associated with the sender of the email message.


Choose the service level agreement (SLA) that you want to apply to the case record.


Last SLA that was applied to this case. This field is for internal use only.


Unique identifier of the currency associated with the activitypointer.

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 activity_pointer_letter
createdby systemuser lk_activitypointer_createdby
createdby_letter systemuser lk_letter_createdby
createdonbehalfby systemuser lk_activitypointer_createdonbehalfby
createdonbehalfby_letter systemuser lk_letter_createdonbehalfby
modifiedby systemuser lk_activitypointer_modifiedby
modifiedby_letter systemuser lk_letter_modifiedby
modifiedonbehalfby systemuser lk_activitypointer_modifiedonbehalfby
modifiedonbehalfby_letter systemuser lk_letter_modifiedonbehalfby
ownerid principal owner_activitypointers
ownerid_letter principal owner_letters
owningbusinessunit businessunit business_unit_activitypointer
owningbusinessunit_letter businessunit business_unit_letter_activities
owningteam team team_activity
owningteam_letter team team_letter
owninguser systemuser user_activity
owninguser_letter systemuser user_letter
regardingobjectid_account account Account_ActivityPointers
regardingobjectid_account_letter account Account_Letters
regardingobjectid_contact contact Contact_ActivityPointers
regardingobjectid_contact_letter contact Contact_Letters
regardingobjectid_knowledgearticle knowledgearticle KnowledgeArticle_ActivityPointers
regardingobjectid_knowledgearticle_letter knowledgearticle KnowledgeArticle_Letters
regardingobjectid_knowledgebaserecord knowledgebaserecord KnowledgeBaseRecord_ActivityPointers
regardingobjectid_knowledgebaserecord_letter knowledgebaserecord KnowledgeBaseRecord_Letters
regardingobjectid_new_interactionforemail interactionforemail new_interactionforemail_ActivityPointers
sendermailboxid mailbox activitypointer_sendermailboxid_mailbox
sla_activitypointer_sla sla manualsla_activitypointer
sla_letter_sla sla manualsla_letter
slainvokedid_activitypointer_sla sla sla_activitypointer
slainvokedid_letter_sla sla sla_letter
stageid_processstage processstage processstage_letters
transactioncurrencyid transactioncurrency TransactionCurrency_ActivityPointer
transactioncurrencyid_letter transactioncurrency TransactionCurrency_Letter

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
activity_pointer_activity_mime_attachment activitymimeattachment objectid_activitypointer
activity_pointer_appointment appointment activityid_activitypointer
activity_pointer_chat chat activityid_chat
activity_pointer_email email activityid_activitypointer
activity_pointer_fax fax activityid_activitypointer
activity_pointer_letter letter activityid_activitypointer
activity_pointer_phonecall phonecall activityid_activitypointer
activity_pointer_recurrencerule recurrencerule objectid
activity_pointer_recurringappointmentmaster recurringappointmentmaster activityid_activitypointer
activity_pointer_socialactivity socialactivity activityid_activitypointer
activity_pointer_task task activityid_activitypointer
activitypointer_activity_parties activityparty activityid_activitypointer
ActivityPointer_AsyncOperations asyncoperation regardingobjectid_activitypointer
ActivityPointer_BulkDeleteFailures bulkdeletefailure regardingobjectid_activitypointer
activitypointer_connections1 connection record1id_activitypointer
activitypointer_connections2 connection record2id_activitypointer
ActivityPointer_QueueItem queueitem objectid_activitypointer
letter_actioncard actioncard regardingobjectid_letter_actioncard
letter_activity_parties activityparty activityid_letter
Letter_Annotation annotation objectid_letter
Letter_AsyncOperations asyncoperation regardingobjectid_letter
Letter_BulkDeleteFailures bulkdeletefailure regardingobjectid_letter
letter_connections1 connection record1id_letter
letter_connections2 connection record2id_letter
Letter_DuplicateBaseRecord duplicaterecord baserecordid_letter
Letter_DuplicateMatchingRecord duplicaterecord duplicaterecordid_letter
letter_principalobjectattributeaccess principalobjectattributeaccess objectid_letter
Letter_ProcessSessions processsession regardingobjectid_letter
Letter_QueueItem queueitem objectid_letter
Letter_SyncErrors syncerror regardingobjectid_letter_syncerror
slakpiinstance_activitypointer slakpiinstance regarding_activitypointer
slakpiinstance_letter slakpiinstance regarding_letter


The following operations can be used with the letter entity type.

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound


The following solutions include the letter entity type.

Name Description
System Solution Internal CRM System Solution
Activities Patch Patch for Dynamics 365 workload for activities.
Application Common For internal use only.

See also