{ "sections": [ "title", "description", "fields", "associated_objects", "wsdl_segment", "field_reference" ], "title": "MessagingEndUser - Data API", "description": "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 40.0 and later.", "fields_columns": [ "type", "properties", "description", "relationship_name", "relationship_type", "refers_to" ], "fields": { "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" }, "LastReferencedDate": { "type": "dateTime", "properties": "Filter, Nillable, Sort" }, "LastViewedDate": { "type": "dateTime", "properties": "Filter, Nillable, Sort" }, "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" }, "Language": { "type": "picklist", "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update" }, "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" }, "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" }, "Name": { "type": "string", "properties": "Create, Filter, Group, idLookup, Sort, Update" }, "OwnerId": { "type": "reference", "properties": "Create, Defaulted on create, Filter, Group, Sort, Update" }, "ProfilePictureUrl": { "type": "url", "properties": "Create, Filter, Group, Nillable, Sort" } }, "associated_objects": "This object has the following associated objects. Unless noted, they’re available in the same API version as this object.\n\n- **MessagingEndUserChangeEvent (API version 62.0)**: Change events are available for the object.\n- **MessagingEndUserHistory**: History is available for tracked fields of the object.\n- **MessagingEndUserOwnerSharingRule**: Sharing rules are available for the object.\n- **MessagingEndUserShare**: Sharing is available for the object.", "wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```", "field_reference": { "AccountId": { "field_label": "Account ID", "type": "reference", "length": "18" }, "AuthenticatedEndUserId": { "field_label": "User ID", "type": "reference", "length": "18" }, "ContactId": { "field_label": "Contact ID", "type": "reference", "length": "18" }, "CreatedById": { "field_label": "Created By ID", "type": "reference", "length": "18" }, "CreatedDate": { "field_label": "Created Date", "type": "datetime" }, "CurrencyIsoCode": { "field_label": "Currency ISO Code", "type": "picklist", "length": "3" }, "HasInitialResponseSent": { "field_label": "Has Initial Response Been Sent", "type": "boolean" }, "Id": { "field_label": "Messaging User ID", "type": "id", "length": "18" }, "IsDeleted": { "field_label": "Deleted", "type": "boolean" }, "IsFullyOptedIn": { "field_label": "Opted In", "type": "boolean" }, "IsoCountryCode": { "field_label": "ISO Country Code", "type": "string", "length": "2" }, "Language": { "field_label": "Language", "type": "picklist", "length": "255" }, "LastModifiedById": { "field_label": "Last Modified By ID", "type": "reference", "length": "18" }, "LastModifiedDate": { "field_label": "Last Modified Date", "type": "datetime" }, "LastReferencedDate": { "field_label": "Last Referenced Date", "type": "datetime" }, "LastViewedDate": { "field_label": "Last Viewed Date", "type": "datetime" }, "LeadId": { "field_label": "Lead ID", "type": "reference", "length": "18" }, "Locale": { "field_label": "Locale", "type": "string", "length": "20" }, "MessageType": { "field_label": "Message Type", "type": "picklist", "length": "255" }, "MessagingChannelId": { "field_label": "Messaging Channel ID", "type": "reference", "length": "18" }, "MessagingConsentStatus": { "field_label": "Messaging Consent Status", "type": "picklist", "length": "255" }, "MessagingExternalUserKey": { "field_label": "Messaging External Key", "type": "string", "length": "255" }, "MessagingPlatformKey": { "field_label": "Messaging Platform Key", "type": "string", "length": "255" }, "Name": { "field_label": "Messaging User Name", "type": "string", "length": "255" }, "OwnerId": { "field_label": "Owner ID", "type": "reference", "length": "18" }, "ProfilePictureUrl": { "field_label": "Profile Picture URL", "type": "url", "length": "255" }, "SystemModstamp": { "field_label": "System Modstamp", "type": "datetime" } }, "field_reference_columns": [ "field_label", "type", "length" ] }