--- schema_version: "1" id: be4418ddfc4f980db7cb60842f56ad67f851da316fef3a6b4e8ded68cce6cd42 title: AuthorizedEmailDomain collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_authorizedemaildomain.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_authorizedemaildomain.htm source_site: developer.salesforce.com content_type: documentation content_hash: ed397adb103f602fac44c52ef9fa44cd169f8e3fb5b63b6cacd910b5495f1362 description: Represents an authorized domain for email verification. This object is available in API version 64.0 and later. --- # AuthorizedEmailDomain Represents an authorized domain for email verification. This object is available in API version 64.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Special Access Rules To create or modify authorized email domains, users must have the Email Administration permission. ## Fields | Field | Details | | --- | --- | | DeveloperName | Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. Note these important considerations. - When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. - Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | DomainName | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique domain name. Example example.com | | Id | Type ID Properties Create, Filter, Group, Sort Description The ID of this authorized email domain. The ID starts with the string 1TB. Example 1TB00000000000B | | IsDomainOwnershipVerified | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Salesforce successfully verified ownership of this domain (true) or not (false). The default value is false. | | IsEmailChangeVerfRqr | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether email address verification is required for updated user email addresses, user return email addresses, and organization-wide email addresses on this domain (true) or not (false). The default value is true. When IsDomainOwnershipVerified is false, then IsEmailChangeVerfRqr has no effect. Available in API version 68.0 and later. | | IsEmailVerificationRequired | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether address verification is required before Salesforce can send email for new users and new organization-wide email addresses with email addresses on this domain (true) or not (false). The default value is true. When IsDomainOwnershipVerified is false, IsEmailVerificationRequired has no effect. When IsDomainOwnershipVerified is true, IsEmailVerificationRequired and IsEmailChangeVerfRqr determine when address verification is required for updated user email addresses, user return email addresses, and organization-wide email addresses on this domain. - If IsEmailVerificationRequired and IsEmailChangeVerfRqr are true, then email address verification is always required before Salesforce can send email for users and organization-wide email addresses with email addresses on this domain. - If IsEmailVerificationRequired is true and IsEmailChangeVerfRqr is false, then address verification isn’t required for new user email addresses, new user return email addresses, and new organization-wide email addresses on this domain. However, address verification is required when an existing user email address, user return email address, or organization-wide email address is updated to an address on this domain. - If IsEmailVerificationRequired and IsEmailChangeVerfRqr are false, then address verification is never required for user email addresses, user return email addresses, and organization-wide email addresses on this domain. | | Language | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the language of the authorized email domain. The value for this field is the language value of the org. | | MasterLabel | Type string Properties Create, Filter, Group, Sort, Update Description Master label for this object. This display value is the internal label that is not translated. | ## Usage Domain verification is required to bypass email verification for an authorized email domain. To verify ownership of an authorized email domain, first create an AuthorizedEmailDomain with IsDomainOwnershipVerified set to false. Then determine the verification code for the authorized email domain. Use the format orgId\=AuthorizedEmailDomainId where orgId is the 15-digit ID for your Salesforce org and AuthorizedEmailDomainId is the authorized email domain Id. You can also find the verification code on the Authorized Email Domains page in Setup. Add a DNS TXT record for the DomainName with or without \_sfdv. as a prefix that points to a verification code. Here’s an example of a DNS TXT record for an authorized email domain with a DomainName of example.com and an AuthorizedEmailDomainId of 1TB00000000000B in an org with ID 00D000000000P08. Name TTL CLASS TYPE VALUE -------------------------------------------------------------------- example.com. 600 IN TXT "00D000000000P08=1TB00000000000B” ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note This example is a raw TXT record. The trailing dot in example.com. tells the DNS server that the name is absolute, stopping the provider from appending anything to the domain name. Check with your DNS provider to determine how to enter the name in their system to get this result. Here’s an example of a DNS TXT record for the same domain with the \_sfdv. prefix. Name TTL CLASS TYPE VALUE -------------------------------------------------------------------- \_sfdv.example.com. 600 IN TXT "00D000000000P08=1TB00000000000B” If a DNS TXT record already exists for DomainName and \_sfdv.DomainName, you can create a second TXT record for one of those names or you can append the verification code to the value list of an existing TXT record. To append a value, separate the values with a semicolon (;). ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note Changes to DNS can take up to 48 hours to propagate across the internet. To start the domain verification process after the required DNS TXT record exists, set IsDomainOwnershipVerified to true. If that verification process succeeds, IsDomainOwnershipVerified remains true. Otherwise, an error is returned and IsDomainOwnershipVerified is set to false. For more information and examples, see [Set Up an Authorized Email Domain](https://help.salesforce.com/s/articleView?id=xcloud.security_email_auth_domain_setup.htm&type=5&language=en_US) in Salesforce Help.