VTEX DKIM Configuration API

The DKIM Configuration API from VTEX — 1 operation(s) for dkim configuration.

Operations 1

POST /api/mail-service/pvt/providers/{EmailProvider}/dkim VTex Generate DKIM keys #

Documentation

📖
Documentation
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
📖
Documentation
https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-api-seller-portal-overview
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-overview
📖
Documentation
https://developers.vtex.com/docs/guides/checkout-overview
📖
Documentation
https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0
📖
Documentation
https://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM
📖
Documentation
https://developers.vtex.com/docs/api-reference/do-api
📖
Documentation
https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
📖
Documentation
https://developers.vtex.com/docs/guides/gift-card-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/faststore/headless-cms-overview
📖
Documentation
https://developers.vtex.com/docs/api-reference/vtex-id-api
📖
Documentation
https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search@1.0.8
📖
Documentation
https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj
📖
Documentation
https://developers.vtex.com/docs/guides/search-overview
📖
Documentation
https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3
📖
Documentation
https://developers.vtex.com/docs/guides/fulfillment
📖
Documentation
https://developers.vtex.com/docs/guides/marketplace-overview
📖
Documentation
https://developers.vtex.com/updates/release-notes/marketplace-protocol-documentation-update
📖
Documentation
https://developers.vtex.com/docs/guides/external-marketplace-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-connector
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw
📖
Documentation
https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials_84
📖
Documentation
https://developers.vtex.com/docs/guides/orders-overview
📖
Documentation
https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data
📖
Documentation
https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m
📖
Documentation
https://developers.vtex.com/docs/guides/payments-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/vtex-pick-and-pack-last-mile--HN7WKV0xoq2ssVjsJlfzr
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-io-documentation-policies
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-hub
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-overview
📖
Documentation
https://developers.vtex.com/docs/guides/profile-system
📖
Documentation
https://developers.vtex.com/docs/guides/promotions-overview
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings
📖
Documentation
https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors
📖
Documentation
https://developers.vtex.com/docs/guides/sessions-system-overview
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-shipping-network
📖
Documentation
https://help.vtex.com/en/tutorial/sku-bindings--1SmrVgNwjJX17hdqwLa0TX
📖
Documentation
https://developers.vtex.com/docs/guides/subscriptions
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search/suggestions
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-tracking

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vtex-dkim-configuration-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vtex-dkim-configuration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  title: VTex Message Center DKIM Configuration API
  license:
    name: MIT
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
tags:
- name: DKIM Configuration
paths:
  /api/mail-service/pvt/providers/{EmailProvider}/dkim:
    post:
      summary: VTex Generate DKIM keys
      description: Create DKIM keys for sender that was setup in VTEX mail servers
      operationId: createDKIM
      tags:
      - DKIM Configuration
      parameters:
      - name: EmailProvider
        in: path
        required: true
        description: E-mail address for sender that was setup in VTEX mail servers
        schema:
          type: string
          default: help@valdie.co
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_OK'
              examples:
                emailNotFound:
                  summary: emailNotFound summary
                  value:
                    status: emailNotFound
                    dkimKeys: null
                emailNotVerified:
                  summary: emailNotVerified summary
                  value:
                    status: emailNotVerified
                    dkimKeys: null
                created:
                  summary: created summary
                  value:
                    status: created
                    dkimKeys:
                    - '''n3zbltwizctxpgcmqrars4bmfdd3zlyo._domainkey.valdie.co'',''CNAME'',''n3zbltwizctxpgcmqrars4bmfdd3zlyo.dkim.amazonses.com'''
                    - '''sq4iae4be52fhqq3wm44btttvndeecfv._domainkey.valdie.co'',''CNAME'',''sq4iae4be52fhqq3wm44btttvndeecfv.dkim.amazonses.com'''
                    - '''n4z6g2g7yfy4pnhjklfesxrrkt4o2ha4._domainkey.valdie.co'',''CNAME'',''n4z6g2g7yfy4pnhjklfesxrrkt4o2ha4.dkim.amazonses.com'''
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401_Unauthorized'
              examples:
                unauthorized:
                  summary: unauthorized summary
                  value:
                    type: https://tools.ietf.org/html/rfc7235#section-3.1
                    title: Unauthorized
                    status: 401
                    traceId: 00-f8949e0e2a80ff4481b4375908349701-a6a7ecf8b50a2043-00
components:
  schemas:
    401_Unauthorized:
      type: object
      additionalProperties: true
      required:
      - type
      - title
      - status
      - traceId
      properties:
        type:
          type: string
          enum:
          - https://tools.ietf.org/html/rfc7235#section-3.1
        title:
          type: string
          enum:
          - Unauthorized
        status:
          type: integer
          enum:
          - 401
        traceId:
          type: string
          pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-00$
    200_OK:
      type: object
      additionalProperties: true
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - emailNotFound
          - emailNotVerified
          - created
        dkimKeys:
          type:
          - array
          - 'null'
          additionalProperties: true
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken