v42

latestOpenAPI 3.0.0MITraw.githubusercontent.com2025-08-281010.7 KB

DKIM configuration

Generate DKIM keys

Create DKIM keys for a sender that was set up in VTEX mail servers.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Message Center	Providers	Add or edit provider

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/api/mail-service/pvt/providers/{EmailProvider}/dkim

Path parameters

EmailProviderstring required

Example:help@valdiestore.co

Email address for the sender that was set up in VTEX mail servers.

Response

status'emailNotFound' | 'emailNotVerified' | 'created'

DKIM key generating status in string format. For the response emailNotFound and emailNotVerified, the sender email should be set up or revised.

dkimKeysstring[] nullable

This field returns DKIM keys when they were successfully created, and null when they were not.

All 1 operations