SocialProfile Entity Reference

Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.

This entity is used to store social profile information of its associated account and contacts on different social channels.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/socialprofiles(socialprofileid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/socialprofiles
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/socialprofiles(socialprofileid)
See Delete
DeleteRequest or
Delete
GenerateSocialProfile GenerateSocialProfile Action GenerateSocialProfileRequest
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/socialprofiles(socialprofileid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/socialprofiles
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/socialprofiles(socialprofileid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/socialprofiles(socialprofileid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName SocialProfiles
DisplayCollectionName Social Profiles
DisplayName Social Profile
EntitySetName socialprofiles
IsBPFEntity False
LogicalCollectionName socialprofiles
LogicalName socialprofile
OwnershipType UserOwned
PrimaryIdAttribute socialprofileid
PrimaryNameAttribute profilename
SchemaName SocialProfile

Writable attributes

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

Blocked

Property Value
Description Identifies if the social profile has been blocked.
DisplayName Blocked
IsValidForForm True
IsValidForRead True
LogicalName blocked
RequiredLevel None
Type Boolean

Blocked Options

Value Label
1 Yes
0 No

DefaultValue: False

Community

Property Value
Description Identifies where the social profile originated from, such as Twitter, or Facebook.
DisplayName Social Channel
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName community
RequiredLevel None
Type Picklist

Community Options

Value Label
0 Other
1 Facebook
2 Twitter
3 Line
4 Wechat
5 Cortana
6 Direct Line
7 Microsoft Teams
8 Direct Line Speech
9 Email
10 GroupMe
11 Kik
12 Telegram
13 Skype
14 Slack
15 WhatsApp

CustomerId

Property Value
Description Shows the customer that this social profile belongs to.
DisplayName Customer
IsValidForForm True
IsValidForRead True
LogicalName customerid
RequiredLevel None
Targets account,contact
Type Customer

CustomerIdName

Property Value
Description Select the parent account or parent contact for the contact to provide a quick link to additional details, such as financial information, activities, and opportunities.
DisplayName Parent Customer Type
FormatName Text
IsLocalizable False
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName customeridname
MaxLength 160
RequiredLevel None
Type String

CustomerIdType

Property Value
Description Select the parent account or parent contact for the contact
DisplayName Parent Customer Type
IsValidForForm False
IsValidForRead True
LogicalName customeridtype
RequiredLevel None
Type EntityName

CustomerIdYomiName

Property Value
Description Select the parent account or parent contact for the contact
DisplayName Parent Customer Type
FormatName Text
IsLocalizable False
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName customeridyominame
MaxLength 450
RequiredLevel None
Type String

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

InfluenceScore

Property Value
Description Shows the score that determines the online social influence of the social profile.
DisplayName Influence Score
IsValidForForm True
IsValidForRead True
LogicalName influencescore
MaxValue 1000000000
MinValue 0
Precision 2
RequiredLevel None
Type Double

msdyn_ocfollowercount

Added by: Omnichannel - Base Patch Solution

Property Value
Description Customer's Followers on the Social channel.
DisplayName Follower Count
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocfollowercount
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_ocfollowingcount

Added by: Omnichannel - Base Patch Solution

Property Value
Description Customer's followings on the Social channel
DisplayName Followings Count
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocfollowingcount
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_ocfriendcount

Added by: Omnichannel - Base Patch Solution

Property Value
Description Customer's Friend count on the Social Channel
DisplayName Friend Count
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocfriendcount
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_octwitterhandleid

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Lookup for Twitter Handle entity.
DisplayName Twitter Handle Id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_octwitterhandleid
RequiredLevel None
Targets msdyn_octwitterhandle
Type Lookup

msdyn_phonenumber

Added by: Omnichannel - Base Patch Solution

Property Value
Description The phone number of the social profile.
DisplayName Phone number
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_phonenumber
MaxLength 100
RequiredLevel None
Type String

Added by: Omnichannel - Base Patch Solution

Property Value
Description Link to the Customer's Social Channel Profile image.
DisplayName Profile Image Link
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_profileimagelink
MaxLength 4000
RequiredLevel None
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Property Value
Description Shows the user or team that is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdType

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

ProfileFullName

Property Value
Description Shows the display name of the customer on this social profile.
DisplayName Full Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName profilefullname
MaxLength 160
RequiredLevel None
Type String
Property Value
Description Shows the customer that this social profile belongs to.
DisplayName Profile Link
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName profilelink
MaxLength 100
RequiredLevel None
Type String

ProfileName

Property Value
Description Shows the name of the social profile on the corresponding social channel.
DisplayName Profile Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName profilename
MaxLength 100
RequiredLevel None
Type String

SocialProfileId

Property Value
Description Unique Identifier of the social profile name.
DisplayName Social Profile ID
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName socialprofileid
RequiredLevel SystemRequired
Type Uniqueidentifier

StateCode

Property Value
Description Status of the Social Profile
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Reason for the status of the Social Profile
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UniqueProfileID

Property Value
Description Unique ID of the Profile ID
DisplayName Unique Profile ID
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName uniqueprofileid
MaxLength 100
RequiredLevel None
Type String

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

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

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

ExchangeRate

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

msdyn_octwitterhandleidName

Added by: Omnichannel – SocialChannels Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_octwitterhandleidname
MaxLength 100
RequiredLevel None
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier of the team who owns the contact.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the contact.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version number of the social profile.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

socialprofile_cases

Added by: Service Solution

Same as incident entity socialprofile_cases Many-To-One relationship.

Property Value
ReferencingEntity incident
ReferencingAttribute socialprofileid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName socialprofile_cases
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Service
Label:
Order: 10
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

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.

lk_SocialProfile_createdonbehalfby

See systemuser Entity lk_SocialProfile_createdonbehalfby One-To-Many relationship.

socialProfile_owning_user

See systemuser Entity socialProfile_owning_user One-To-Many relationship.

lk_SocialProfile_modifiedonbehalfby

See systemuser Entity lk_SocialProfile_modifiedonbehalfby One-To-Many relationship.

See also

Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service