VTEX · Example Payload

Vtex Get Apirnspubsubscriptionssubscriptionidconversation Message Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Apirnspubsubscriptionssubscriptionidconversation Message 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

Raw ↑ 
{
  "operationId": "get-apirnspubsubscriptionssubscriptionidconversation-message",
  "method": "GET",
  "path": "/api/rns/pub/subscriptions/{subscriptionId}/conversation-message",
  "summary": "VTex Get conversation messages",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "string",
          "from": {
            "conversationRelatedTo": "string",
            "conversationSubject": "string",
            "emailAlias": "string",
            "aliasMaskType": "string",
            "email": "string",
            "name": "string",
            "role": "string"
          },
          "to": [
            {
              "conversationRelatedTo": "string",
              "conversationSubject": "string",
              "emailAlias": "string",
              "aliasMaskType": "string",
              "email": "string",
              "name": "string",
              "role": "string"
            }
          ],
          "subject": "string",
          "firstWords": "string",
          "body": "string",
          "hasAttachment": true,
          "attachmentNames": [
            "string"
          ],
          "date": "2021-08-31T22:50:53.564Z"
        }
      ]
    }
  ]
}