VTEX · Schema

To

Conversation receiver.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
conversationRelatedTo string Related order ID.
conversationSubject string Conversation subject.
emailAlias string Sender transactional tracker email.
aliasMaskType integer Conversation tracker mask type.
email string Receiver's email.
name string Receiver's name.
role string If it is a customer or null, for transactional emails.
View JSON Schema on GitHub

JSON Schema

vtex-to-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/To",
  "title": "To",
  "description": "Conversation receiver.",
  "required": [
    "conversationRelatedTo",
    "conversationSubject",
    "emailAlias",
    "aliasMaskType",
    "email",
    "name",
    "role"
  ],
  "type": "object",
  "properties": {
    "conversationRelatedTo": {
      "type": "string",
      "description": "Related order ID.",
      "example": "1305371685465-01"
    },
    "conversationSubject": {
      "type": "string",
      "description": "Conversation subject.",
      "example": "oms"
    },
    "emailAlias": {
      "type": "string",
      "description": "Sender transactional tracker email.",
      "example": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br"
    },
    "aliasMaskType": {
      "type": "integer",
      "description": "Conversation tracker mask type.",
      "example": 0
    },
    "email": {
      "type": "string",
      "description": "Receiver's email.",
      "example": "customer.name@email.com"
    },
    "name": {
      "type": "string",
      "description": "Receiver's name.",
      "example": "Mary John"
    },
    "role": {
      "type": "string",
      "description": "If it is a customer or null, for transactional emails.",
      "example": "Customer"
    }
  },
  "example": {
    "conversationRelatedTo": "1305371685465-01",
    "conversationSubject": "oms",
    "emailAlias": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br",
    "aliasMaskType": 0,
    "email": "customer.name@email.com",
    "name": "Mary John",
    "role": "Customer"
  }
}