VTvtex
DKIM configuration

Generate DKIM keys

Changed on

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:

ProductCategoryResource
Message CenterProvidersAdd 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

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/mail-service/pvt/providers/{EmailProvider}/dkim
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

EmailProviderstring required
Example:help@valdiestore.co

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

Response

OK

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.

Changes

  • 57bdbbd2b85cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2728ab222b9eRevision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status