VTEX · Example Payload

Vtex Createdkim Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createdkim Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "createDKIM",
  "method": "POST",
  "path": "/api/mail-service/pvt/providers/{EmailProvider}/dkim",
  "summary": "VTex Generate DKIM keys",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "emailNotFound",
      "example": {
        "status": "emailNotFound",
        "dkimKeys": null
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "emailNotVerified",
      "example": {
        "status": "emailNotVerified",
        "dkimKeys": null
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "created",
      "example": {
        "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'"
        ]
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "name": "unauthorized",
      "example": {
        "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
        "title": "Unauthorized",
        "status": 401,
        "traceId": "00-f8949e0e2a80ff4481b4375908349701-a6a7ecf8b50a2043-00"
      }
    }
  ]
}