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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "OrgWideEmailAddress - Data API",
  "description": "Represents an organization-wide email address for user profiles.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "purpose"
  ],
  "fields": {
    "Address": {
      "type": "email",
      "properties": "Create, Filter, Sort, Update",
      "description": "An email alias that can be used by users of your org."
    },
    "DisplayName": {
      "type": "string",
      "properties": "Create, Filter, Sort, Update",
      "description": "The name used to identify the sender of the email."
    },
    "IsAllowAllProfiles": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "If true, any user profile in your organization can use this object. If false, only specified user profiles can use this object when sending email. If you do not have the appropriate user profile, you can’t use this object. The default value is false.."
    },
    "IsVerified": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the email address has been verified by its owner. The default value is false. This field is available in API version 58.0 and later.",
      "purpose": "Picklist"
    },
    "Purpose": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Indicates how an email address can be used. UserSelection allows users with the correct profile to select the address as the From address for an email. Possible values are DefaultNoreply, UserSelection, UserSelectionAndDefaultNoReply."
    }
  },
  "special_access_rules": "Only authenticated users with the View Setup and Configuration permission can access this object.",
  "usage": "This object represents an email alias to use as the From address for an email, which can be selected by users with a user profile. You can pass in the OrgWideEmailAddress ID when calling sendEmail() for a SingleEmailMessage.",
  "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=\"OrgWideEmailAddress\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Address\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"DisplayName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsAllowAllProfiles\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsVerified\" 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=\"OrgEmailAddressSecurityItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Purpose\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SetupEntityAccessItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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": {
    "Address": {
      "field_label": "Email Address",
      "type": "email",
      "length": "270"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DisplayName": {
      "field_label": "Display Name",
      "type": "string",
      "length": "300"
    },
    "Id": {
      "field_label": "Organization-wide From Email Address ID",
      "type": "id",
      "length": "18"
    },
    "IsAllowAllProfiles": {
      "field_label": "Allow All Profiles",
      "type": "boolean"
    },
    "IsVerified": {
      "field_label": "Status",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Purpose": {
      "field_label": "Purpose",
      "type": "picklist",
      "length": "40"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}