PUT - Verify DKIM Public Key
Purpose
This API is used to verify a DKIM public key of a particular domain.
OAuth Scope
Use the scope
ZohoMail.organization.domains.ALL (or) ZohoMail.organization.domains.UPDATE
to generate the Authtoken.
ALL - Grants full access to domains.
UPDATE - Grants update access to domains.
Request URL
Method: PUT
https://mail.zoho.com/api/organization/{zoid}/domains/{domainName}
Path Parameters
- zoid* long
- This parameter specifies the unique Zoho Organization Identifier for the organization.
- This parameter can be fetched from Get Organization Details API.
- domainName* string
- This parameter specifies the name of the domain, for which you want to verify a DKIM public key.
Request Body (JSON object)
- mode* string
- This parameter represents the type of operation that is to be performed.
- Provide the value as verifyDkimKey.
- dkimId* long
- This parameter specifies the unique ID of the DKIM value.
- This parameter can be fetched from the Get All Domains Details API or Get A Domain Details API or Add DKIM Details API response.
* - Mandatory parameter
Response Codes
Refer here for the response codes and their meaning.
Sample Request
Copiedcurl " https://mail.zoho.com/api/organization/1234567890/domains/zylker.com" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d '{
"mode":"verifyDkimKey",
"dkimId":"100000500000888000"
}'Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
},
"data": {
"dkimstatus": true
}
}