Restart the verification of an email domain
restart_site_email_domain_verification
Starts the verification of an email domain over when the mail provider gave up on it, which changes its three DKIM records.
It is for a domain the mail provider gave up on (dkimStatus failed or not_started) or whose setup is missing, which canRestart in emailDomains.items reports. It sets the domain up again with the mail provider, so its three DKIM records change, and you replace them at your DNS host with the new values in the answer. The ownership record stays the same.
It is refused with This domain is verified, so there is nothing to restart! while the domain is verified on any site. Once the mail provider has confirmed its sending records (dkimStatus success), it is refused with The mail provider already confirmed this domain's sending records, so there is nothing to restart!, and its ownership record is then the one to check. While the mail provider is still verifying it (dkimStatus pending or temporary_failure), it is refused with The mail provider is still verifying this domain, so there is nothing to restart!
A workspace can restart verification at most 10 times an hour across all its sites, and past that it is refused with This workspace has restarted email domain verification too many times this hour. followed by how long to wait. A paused domain is refused with Email domains are paused until the workspace is on a paid plan again!
The tool tells the client to always confirm with you first. It needs the Manage domains permission. See Restart verification.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
domainId |
string | Yes | The id of the email domain, from emailDomains.items in get_site_email_settings. |