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

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ContactPointPhone - Data API",
  "description": "Represents a contact’s phone number, which is associated with an individual or person account. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "ActiveFromDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The date when the contact’s phone number became active."
    },
    "ActiveToDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The date when the contact’s phone number is no longer active."
    },
    "AreaCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The area code of the phone number’s location for the contact."
    },
    "BestTimeToContactEndTime": {
      "type": "time",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The latest time to contact the individual."
    },
    "BestTimeToContactStartTime": {
      "type": "time",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The earliest time to contact the individual."
    },
    "BestTimeToContactTimezone": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The timezone applied to the best time to contact the individual."
    },
    "ExtensionNumber": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The phone number extension for the contact."
    },
    "FormattedInternationalPhoneNumber": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The internationally recognized format for the contact’s phone number."
    },
    "FormattedNationalPhoneNumber": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The nationally recognized format for the contact’s phone number."
    },
    "IsBusinessPhone": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s phone number is a business number (true) or not (false)."
    },
    "IsFaxCapable": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s phone number is a fax number (true) or not (false)."
    },
    "IsPersonalPhone": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s phone number is a personal number (true) or not (false)."
    },
    "IsPrimary": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s phone number is their primary number (true) or not (false)."
    },
    "IsSmsCapable": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s phone number can receive text messages (true) or not (false)."
    },
    "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, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Nillable, Sort",
      "description": "The name of the contact point phone record.",
      "required": true
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The ID of the account’s owner associated with this contact. This is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "ParentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the contact’s parent. Only an individual or account can be a contact’s parent. This is a polymorphic relationship field.",
      "relationship_name": "Parent",
      "relationship_type": "Lookup",
      "refers_to": "Account, Individual"
    },
    "PhoneType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The type of phone number for the contact. Possible values are: Home Mobile"
    },
    "PreferenceRank": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Specify how this phone numbers ranks in terms of preference among the contact’s other phone numbers."
    },
    "TelephoneNumber": {
      "type": "phone",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The phone number for the contact.",
      "required": true
    },
    "UsageType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Specify the usage type of this number. For instance, whether it’s a work phone or a home phone. Possible values are: Home Temp Work"
    }
  },
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **ContactPointConsentChangeEvent**: Change events are available for the object.\n- **ContactPointPhoneHistory**: History is available for tracked fields of the object.\n- **ContactPointPhoneOwnerSharingRule**: Sharing rules are available for the object.\n- **ContactPointPhoneShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"ContactPointPhone\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActiveFromDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"ActiveToDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AreaCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"BestTimeToContactEndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:time\"/>\n        <element name=\"BestTimeToContactStartTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:time\"/>\n        <element name=\"BestTimeToContactTimezone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CommSubscriptionConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContactPointAddresses\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContactPointConsents\" 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=\"ExtensionNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FormattedInternationalPhoneNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FormattedNationalPhoneNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsBusinessPhone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsFaxCapable\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsPersonalPhone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsPrimary\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsSmsCapable\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\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=\"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=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ParentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PhoneType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PreferenceRank\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\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=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TelephoneNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UsageType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\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<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": {
    "ActiveFromDate": {
      "field_label": "Active from Date",
      "type": "date"
    },
    "ActiveToDate": {
      "field_label": "Active to Date",
      "type": "date"
    },
    "AreaCode": {
      "field_label": "Area code",
      "type": "string",
      "length": "30"
    },
    "BestTimeToContactEndTime": {
      "field_label": "Best time to contact end time",
      "type": "time"
    },
    "BestTimeToContactStartTime": {
      "field_label": "Best time to contact start time",
      "type": "time"
    },
    "BestTimeToContactTimezone": {
      "field_label": "Best time to contact time zone",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "ExtensionNumber": {
      "field_label": "Extension number",
      "type": "string",
      "length": "30"
    },
    "FormattedInternationalPhoneNumber": {
      "field_label": "Formatted international phone number",
      "type": "string",
      "length": "250"
    },
    "FormattedNationalPhoneNumber": {
      "field_label": "Formatted national phone number",
      "type": "string",
      "length": "250"
    },
    "Id": {
      "field_label": "Contact Point Phone ID",
      "type": "id",
      "length": "18"
    },
    "IsBusinessPhone": {
      "field_label": "Is business phone",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsFaxCapable": {
      "field_label": "Is fax capable",
      "type": "boolean"
    },
    "IsPersonalPhone": {
      "field_label": "Is personal phone",
      "type": "boolean"
    },
    "IsPrimary": {
      "field_label": "Is Primary",
      "type": "boolean"
    },
    "IsSmsCapable": {
      "field_label": "Is SMS capable",
      "type": "boolean"
    },
    "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"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "ParentId": {
      "field_label": "Parent ID",
      "type": "reference",
      "length": "18"
    },
    "PhoneType": {
      "field_label": "Phone Type",
      "type": "picklist",
      "length": "255"
    },
    "PreferenceRank": {
      "field_label": "Preference Rank",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TelephoneNumber": {
      "field_label": "Telephone number",
      "type": "phone",
      "length": "40"
    },
    "UsageType": {
      "field_label": "Usage Type",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}