afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/MessagingEndUser.json

{
  "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<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"MessagingEndUser\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Account\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"AccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"AuthenticatedEndUser\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"AuthenticatedEndUserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Contact\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Contact\"/>\n        <element name=\"ContactId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ConversationEntries\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ConversationParticipants\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"HasInitialResponseSent\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsFullyOptedIn\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsoCountryCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Lead\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Lead\"/>\n        <element name=\"LeadId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Locale\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MessageType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MessagingChannel\" nillable=\"true\" minOccurs=\"0\" type=\"ens:MessagingChannel\"/>\n        <element name=\"MessagingChannelId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"MessagingConsentStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MessagingPlatformKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MessagingSessions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProfilePictureUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\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"
  ]
}