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.2/letters
- Base type:
- activitypointer
- Table type:
- Standard
- Display name:
- Letter
- Primary key:
- activityid
- Primary name column:
- subject
- Operations supported:
- POST GET PATCH DELETE
Properties
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. Inherited from: activitypointer |
||||||||||||
| activityid | Edm.Guid |
Unique identifier of the activity. Display name: Letter Inherited from: activitypointer |
||||||||||||
| activitytypecode | Edm.String |
Type of activity. Display name: Activity Type Inherited from: activitypointer Read only
|
||||||||||||
| actualdurationminutes | Edm.Int32 |
Actual duration of the activity in minutes. Display name: Duration Inherited from: activitypointer |
||||||||||||
| actualend | Edm.DateTimeOffset |
Actual end time of the activity. Display name: Actual End Inherited from: activitypointer |
||||||||||||
| actualstart | Edm.DateTimeOffset |
Actual start time of the activity. Display name: Actual Start Inherited from: activitypointer |
||||||||||||
| address | Edm.String |
Type the complete recipient address for the letter to ensure timely delivery. Display name: Address Inherited from: activitypointer |
||||||||||||
| 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 Inherited from: activitypointer |
||||||||||||
| community | Edm.Int32 |
Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only. Inherited from: activitypointer |
||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the activity was created. Display name: Created On Inherited from: activitypointer Read only
|
||||||||||||
| deliverylastattemptedon | Edm.DateTimeOffset |
Date and time when the delivery of the activity was last attempted. Inherited from: activitypointer Read only
|
||||||||||||
| deliveryprioritycode | Edm.Int32 |
Priority of delivery of the activity to the email server. Inherited from: activitypointer |
||||||||||||
| description | Edm.String |
Description of the activity. Display name: Description Inherited from: activitypointer |
||||||||||||
| descriptionblobid | Edm.Binary |
File that contains description content. Inherited from: activitypointer Read only
|
||||||||||||
| descriptionblobid_name | Edm.String |
Inherited from: activitypointer Read only
|
||||||||||||
| directioncode | Edm.Boolean |
Select the direction of the letter as incoming or outbound. Display name: Direction Inherited from: activitypointer
Default options
|
||||||||||||
| exchangeitemid | Edm.String |
The message id of activity which is returned from Exchange Server. Inherited from: activitypointer |
||||||||||||
| exchangerate | Edm.Decimal |
Exchange rate for the currency associated with the activitypointer with respect to the base currency. Display name: Exchange Rate Inherited from: activitypointer Read only
|
||||||||||||
| exchangeweblink | Edm.String |
Shows the web link of Activity of type email. Inherited from: activitypointer |
||||||||||||
| formattedscheduledend | Edm.DateTimeOffset |
Formatted scheduled end time of the activity. Inherited from: activitypointer Read only
|
||||||||||||
| formattedscheduledstart | Edm.DateTimeOffset |
Formatted scheduled start time of the activity. Inherited from: activitypointer Read only
|
||||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number Inherited from: activitypointer |
||||||||||||
| instancetypecode | Edm.Int32 |
Type of instance of a recurring series. Inherited from: activitypointer Read only
|
||||||||||||
| isbilled | Edm.Boolean |
Information regarding whether the activity was billed as part of resolving a case. Display name: Is Billed Inherited from: activitypointer
Default options
|
||||||||||||
| ismapiprivate | Edm.Boolean |
For internal use only. Inherited from: activitypointer |
||||||||||||
| isregularactivity | Edm.Boolean |
Information regarding whether the activity is a regular activity type or event type. Display name: Is Regular Activity Inherited from: activitypointer Read only
Default options
|
||||||||||||
| isworkflowcreated | Edm.Boolean |
Information regarding whether the activity was created from a workflow rule. Display name: Is Workflow Created Inherited from: activitypointer
Default options
|
||||||||||||
| lastonholdtime | Edm.DateTimeOffset |
Contains the date and time stamp of the last on hold time. Display name: Last On Hold Time Inherited from: activitypointer |
||||||||||||
| leftvoicemail | Edm.Boolean |
Left the voice mail Inherited from: activitypointer |
||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when activity was last modified. Display name: Modified On Inherited from: activitypointer Read only
|
||||||||||||
| onholdtime | Edm.Int32 |
Shows how long, in minutes, that the record was on hold. Display name: On Hold Time (Minutes) Inherited from: activitypointer Read only
|
||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On Inherited from: activitypointer |
||||||||||||
| postponeactivityprocessinguntil | Edm.DateTimeOffset |
For internal use only. Inherited from: activitypointer Read only
|
||||||||||||
| prioritycode | Edm.Int32 |
Priority of the activity. Display name: Priority Inherited from: activitypointer
Default options
|
||||||||||||
| processid | Edm.Guid |
Unique identifier of the Process. Display name: Process Inherited from: activitypointer |
||||||||||||
| scheduleddurationminutes | Edm.Int32 |
Scheduled duration of the activity, specified in minutes. Display name: Scheduled Duration Inherited from: activitypointer |
||||||||||||
| scheduledend | Edm.DateTimeOffset |
Scheduled end time of the activity. Display name: Due Date Inherited from: activitypointer |
||||||||||||
| scheduledstart | Edm.DateTimeOffset |
Scheduled start time of the activity. Display name: Start Date Inherited from: activitypointer |
||||||||||||
| senton | Edm.DateTimeOffset |
Date and time when the activity was sent. Inherited from: activitypointer Read only
|
||||||||||||
| seriesid | Edm.Guid |
Uniqueidentifier specifying the id of recurring series of an instance. Inherited from: activitypointer Read only
|
||||||||||||
| sortdate | Edm.DateTimeOffset |
Shows the date and time by which the activities are sorted. Display name: Sort Date Inherited from: activitypointer |
||||||||||||
| stageid | Edm.Guid |
Unique identifier of the Stage. Display name: (Deprecated) Process Stage Inherited from: activitypointer |
||||||||||||
| statecode | Edm.Int32 |
Status of the activity. Display name: Activity Status Inherited from: activitypointer
Default options
|
||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the activity. Display name: Status Reason Inherited from: activitypointer
Default options
|
||||||||||||
| 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 Inherited from: activitypointer |
||||||||||||
| subject | Edm.String |
Subject associated with the activity. Display name: Subject Inherited from: activitypointer |
||||||||||||
| subscriptionid | Edm.Guid |
For internal use only. Display name: Subscription Inherited from: activitypointer |
||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number Inherited from: activitypointer |
||||||||||||
| traversedpath | Edm.String |
For internal use only. Display name: (Deprecated) Traversed Path Inherited from: activitypointer |
||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code Inherited from: activitypointer |
||||||||||||
| versionnumber | Edm.Int64 |
Version number of the activity. Display name: Version Number Inherited from: activitypointer 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 Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the activity. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the activitypointer. |
| _modifiedby_value | modifiedby |
Unique identifier of user who last modified the activity. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the activitypointer. |
| _ownerid_value | ownerid |
Unique identifier of the user or team who owns the activity. |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier of the business unit that owns the activity. |
| _owningteam_value | owningteam |
Unique identifier of the team that owns the activity. |
| _owninguser_value | owninguser |
Unique identifier of the user that owns the activity. |
| _regardingobjectid_value | regardingobjectid_account regardingobjectid_adx_invitation regardingobjectid_contact regardingobjectid_knowledgearticle regardingobjectid_knowledgebaserecord regardingobjectid_mspp_adplacement regardingobjectid_mspp_pollplacement regardingobjectid_mspp_publishingstatetransitionrule regardingobjectid_mspp_redirect regardingobjectid_mspp_shortcut regardingobjectid_mspp_website regardingobjectid_new_interactionforemail |
Unique identifier of the object with which the activity is associated. |
| _sendermailboxid_value | sendermailboxid |
Unique identifier of the mailbox associated with the sender of the email message. |
| _slaid_value | sla_activitypointer_sla |
Choose the service level agreement (SLA) that you want to apply to the case record. |
| _slainvokedid_value | slainvokedid_activitypointer_sla |
Last SLA that was applied to this case. This field is for internal use only. |
| _transactioncurrencyid_value | transactioncurrencyid |
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_adx_invitation | adx_invitation | adx_invitation_ActivityPointers |
| regardingobjectid_adx_invitation_letter | adx_invitation | adx_invitation_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_mspp_adplacement | mspp_adplacement | mspp_adplacement_ActivityPointers |
| regardingobjectid_mspp_adplacement_letter | mspp_adplacement | mspp_adplacement_Letters |
| regardingobjectid_mspp_pollplacement | mspp_pollplacement | mspp_pollplacement_ActivityPointers |
| regardingobjectid_mspp_pollplacement_letter | mspp_pollplacement | mspp_pollplacement_Letters |
| regardingobjectid_mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule_ActivityPointers |
| regardingobjectid_mspp_publishingstatetransitionrule_letter | mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule_Letters |
| regardingobjectid_mspp_redirect | mspp_redirect | mspp_redirect_ActivityPointers |
| regardingobjectid_mspp_redirect_letter | mspp_redirect | mspp_redirect_Letters |
| regardingobjectid_mspp_shortcut | mspp_shortcut | mspp_shortcut_ActivityPointers |
| regardingobjectid_mspp_shortcut_letter | mspp_shortcut | mspp_shortcut_Letters |
| regardingobjectid_mspp_website | mspp_website | mspp_website_ActivityPointers |
| regardingobjectid_mspp_website_letter | mspp_website | mspp_website_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_adx_inviteredemption | adx_inviteredemption | activityid_adx_inviteredemption |
| activity_pointer_adx_portalcomment | adx_portalcomment | activityid_adx_portalcomment |
| activity_pointer_appointment | appointment | activityid_activitypointer |
| activity_pointer_chat | chat | activityid_chat |
| activity_pointer_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_FileAttachments | fileattachment | objectid_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 |
Operations
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 |