VTEX · Schema

From

Conversation sender.

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	Sender's email.
name	string	Sender's name.
role	string	If it is a client or null, for transactional emails.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/From",
  "title": "From",
  "description": "Conversation sender.",
  "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": "[email protected]"
    },
    "aliasMaskType": {
      "type": "integer",
      "description": "Conversation tracker mask type.",
      "example": 0
    },
    "email": {
      "type": "string",
      "description": "Sender's email.",
      "example": "[email protected]"
    },
    "name": {
      "type": "string",
      "description": "Sender's name.",
      "example": "no reply"
    },
    "role": {
      "type": "string",
      "nullable": true,
      "description": "If it is a client or null, for transactional emails.",
      "example": "null"
    }
  },
  "example": {
    "conversationRelatedTo": "1305371685465-01",
    "conversationSubject": "oms",
    "emailAlias": "[email protected]",
    "aliasMaskType": 0,
    "email": "[email protected]",
    "name": "no reply",
    "role": "null"
  }
}