Newer Version Available

This content describes an older version of this product. View Latest

MessagingEndUser

Represents a single address—such as a phone number or Facebook page—communicating with a single Messaging channel. This object is available in API version 45.0 and later

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the account associated with this Messaging end user.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the associated Contact.
HasInitialResponseSent
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether an initial response has been sent to the Messaging end user (true) or not (false).
IsFullyOptedIn
Type
boolean
Properties
Defaulted on create, Filter, Sort
Description
Indicates whether the Messaging end user has opted in to receiving messages (true) or not (false). This field is available in API version 48.0 and later.
IsOptedOut
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the Messaging end user has opted out of receiving messages. Maximum API version 48.0. Use MessagingConsentStatus and IsFullyOptedIn instead.
IsoCountryCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
The ISO country code associated with the Messaging end user.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Locale
Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
Reserved for future use.
MessageType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Type of message. Possible values are:
  • Facebook
  • Phone
  • Text
  • WhatsApp
MessagingChannelId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the Messaging channel associated with the Messaging end user.
MessagingConsentStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The consent status of the messaging user. This field is available in API version 48.0 and later. Possible values are:
  • DoublyOptedIn
  • ExplicitlyOptedIn
  • ImplicitlyOptedIn
  • OptedOut
MessagingPlatformKey
Type
string
Properties
Create, Filter, Group, Sort
Description

The phone number or Facebook page ID associated with this Messaging end user.

Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the Messaging end user.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner associated with this Messaging end user.
ProfilePictureUrl
Type
url
Properties
Create, Filter, Group, Nillable, Sort
Description
The URL of the Messaging end user's profile picture.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

MessagingEndUserHistory
History is available for tracked fields of the object.
MessagingEndUserOwnerSharingRule
Sharing rules are available for the object.
MessagingEndUserShare
Sharing is available for the object.