| AccountId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- ID of the Account associated with this Messaging end user. Available in API
version 43.0 and later.
- This field is a relationship field.
- Relationship Name
- Account
- Relationship Type
- Lookup
- Refers To
- Account
|
| ContactId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- ID of the associated Contact. Available in API version 43.0 and later.
- This field is a relationship field.
- Relationship Name
- Contact
- Relationship Type
- Lookup
- Refers To
- 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 compares the related messaging channel’s
consent requirement to the user’s consent status; if the user’s status meets
the channel’s required consent level, IsFullyOptedIn is
set to true. 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. Available in API version 48.0 and earlier. 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.
|
| LeadId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- ID of the associated lead. Available in API version 57.0 and later.
- This field is a relationship field.
- Relationship Name
- Lead
- Relationship Type
- Lookup
- Refers To
- Lead
|
|
Locale
|
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- Reserved for future use.
|
|
Language
|
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- The preferred language of the messaging user who participated in the
messaging session. SUpported for Messaging for In-App and Web and Apple
Messages for Business only.
|
|
MessageType
|
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort
- Description
- Type of message. Possible values are:
-
AppleBusinessChat—Represents Apple
Messages for Business.
-
Custom—Represents Bring Your Own
Channel. Available in API version 58.0 and later.
-
EmbeddedMessaging—Represents
Messaging for In-App and Web. Available in API version 50.0 and
later.
- Facebook
- Phone
- Text
- Voice
- WhatsApp
|
|
MessagingChannelId
|
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The ID of the Messaging channel associated with the Messaging end user.
- This is a relationship field.
- Relationship Name
- MessagingChannel
- Relationship Type
- Lookup
- Refers To
- MessagingChannel
|
|
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
|
| MessagingExternalUserKey |
- Type
- string
- Properties
- Filter, Group, Nillable
- Description
- The business-scoped user identifier provided by external messaging platforms
such as Meta. This opaque, stable identifier uniquely represents the end user
within the context of your business relationship on that platform. Available
in API version 63.0 and later.
|
|
MessagingPlatformKey
|
- Type
- string
- Properties
- Create, Filter, Group, Sort
- Description
-
The phone number, Facebook page ID, or unique key associated with this
Messaging end user.
|
|
Name
|
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- The name of the Messaging end user. Because this field is editable, we don’t
recommend referencing it in automation. Instead, use the Messaging Platform
Key.
|
|
OwnerId
|
- Type
- reference
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- ID of the owner associated with this Messaging end user.
- This is a polymorphic relationship field.
- Relationship Name
- Owner
- Relationship Type
- Lookup
- Refers To
- Group, User
|
|
ProfilePictureUrl
|
- Type
- url
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The URL of the Messaging end user's profile picture.
|
j