openapi: 3.0.0
info:
  version: 1.0.0
  title: VTex Message Center 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
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:
                emailNotVerified:
                  summary: emailNotVerified summary
                  value:
                    status: emailNotVerified
                    dkimKeys:
                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
security:
  - appKey: []
    appToken: []
components:
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
  schemas:
    200_OK:
      type: object
      additionalProperties: true
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - emailNotFound
            - emailNotVerified
            - created
        dkimKeys:
          type: array
          additionalProperties: true
          nullable: true
    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$
tags:
  - name: DKIM Configuration