{"id":4811,"date":"2017-03-17T10:38:45","date_gmt":"2017-03-17T14:38:45","guid":{"rendered":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/?post_type=ht_kb&p=4811"},"modified":"2025-04-15T17:55:37","modified_gmt":"2025-04-15T21:55:37","slug":"datamotion-api-headers","status":"publish","type":"ht_kb","link":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/?ht_kb=datamotion-api-headers","title":{"rendered":"DataMotion API Headers"},"content":{"rendered":"Est. reading time:<\/span> 2<\/span> minutes<\/span><\/span>\n

Headers & MessageAttributes<\/h2>\n

All X-Headers that are currently used by DataMotion are described in this article. Each X-Header is its own section with the corresponding MessageAttribute and information contained in the text of the section.<\/p>\n \t\t

\r\n \t\t\tNote<\/span> \t\t\t \t\t\t\t

\r\n \t\t\t\t\tFor technical information regarding the API methods and their expected request formats see the DataMotion Developer Center<\/a>\u00a0website. \t\t\t\t<\/p>\r\n \t\t\t \t\t\t\r\n \t\t<\/div>\r\n \t\t\n

X-COBRAND<\/strong><\/h3>\n

MessageAttribute.CoBrand <\/strong><\/p>\n

    \n
  • Not used in code.<\/li>\n<\/ul>\n

    X-EMAILRECEIPT<\/h3>\n

    MessageAttribute.EmailReceipt<\/strong><\/p>\n

    Expected to be numeric:<\/p>\n

      \n
    • MessageReceipt.DontSend = 0<\/li>\n
    • MessageReceipt.Send = 1<\/li>\n<\/ul>\n

      X-EXPIRE<\/h3>\n

      MessageAttribute.Expire<\/strong><\/p>\n

      Expected to be numeric:<\/p>\n

        \n
      • Value is added as days to the creation time to get the expiration time.<\/li>\n<\/ul>\n

        X-HINT<\/h3>\n

        MessageAttribute.Hint<\/p>\n

        Expected to be a string:<\/p>\n

          \n
        • Value is used as the password hint displayed to the user in a “password protected” message.<\/li>\n<\/ul>\n

          X-ANSWER<\/h3>\n

          MessageAttribute.Password <\/strong><\/p>\n

          Expected to be a string:<\/p>\n

            \n
          • Value is used as the password for the “password protected” message. This value is plain text, and is stored as plain text.<\/li>\n
          • If PDF\/Zip push is enabled, this is used for the password on the PDF\/Zip.<\/li>\n<\/ul>\n

            X-REGCODE<\/h3>\n

            MessageAttribute.RegCode <\/strong><\/p>\n

              \n
            • Not used in code.<\/li>\n<\/ul>\n

              X-SSL<\/h3>\n

              MessageAttribute.SSL <\/strong><\/p>\n

                \n
              • Not used in code.<\/li>\n<\/ul>\n

                X-USERTYPE<\/h3>\n

                MessageAttribute.UserType <\/strong><\/p>\n

                  \n
                • Not used in code.<\/li>\n<\/ul>\n

                  X-PRIORITY<\/h3>\n

                  MessageAttribute.Priority<\/strong><\/p>\n

                  Expected to be numeric:<\/p>\n

                    \n
                  • 1,2 = high priority<\/li>\n
                  • 4,5 = low priority<\/li>\n
                  • Everything else = normal priority. (everything includes 3)<\/li>\n<\/ul>\n

                    X-NOFORWARD<\/h3>\n

                    MessageAttribute.NoForward<\/strong><\/p>\n

                    Expected to be numeric:<\/p>\n

                      \n
                    • 1 = restrict forward<\/li>\n
                    • Anything else = use userprops.<\/li>\n<\/ul>\n

                      X-NOREPLY<\/h3>\n

                      MessageAttribute.NoReply <\/strong><\/p>\n

                      Expected to be numeric:<\/p>\n

                        \n
                      • 1 = restrict forward<\/li>\n
                      • Anything else = use userprops.<\/li>\n<\/ul>\n

                        Disposition-Notification-To<\/h3>\n

                        MessageAttribute.ReadConfirmation <\/strong><\/p>\n

                          \n
                        • Anything other than empty string is considered true.<\/li>\n
                        • Generally this is an email address.<\/li>\n<\/ul>\n

                          MessageAttribute.Xrcpt<\/strong><\/p>\n

                            \n
                          • If not empty and different than the SCSeverAccount psv setting, used for a BCC property.<\/li>\n<\/ul>\n

                            X-MAILER<\/h3>\n

                            MessageAttribute.XMailer\u00a0<\/strong><\/p>\n

                              \n
                            • Saved by the collector<\/li>\n<\/ul>\n

                              X-MimeOLE<\/h3>\n

                              MessageAttribute.XMimeOle <\/strong><\/p>\n

                                \n
                              • Not used in code<\/li>\n<\/ul>\n

                                X-DM-RefID<\/h3>\n

                                MessageAttribute.CustomID <\/strong><\/p>\n

                                  \n
                                • Related to E-Forms<\/li>\n<\/ul>\n

                                  X-SENDER<\/h3>\n

                                  MessageAttribute.XSender<\/strong><\/p>\n

                                    \n
                                  • Not used in code<\/li>\n<\/ul>\n

                                    X-RULESMATCHED<\/h3>\n

                                    MessageAttribute.RulesMatched <\/strong><\/p>\n

                                      \n
                                    • Filled by Gateway rule engine<\/li>\n<\/ul>\n

                                      Trial Account Provisioning<\/h2>\n

                                      The following headers pertain to trial account provisioning.<\/p>\n

                                      <\/div>\n

                                      X-CMRCPTTRIALLICENSE<\/h3>\n

                                      MessageAttribute.CmRcptTrialLicense<\/p>\n

                                      X-CMRCPTPHONE<\/h3>\n

                                      MessageAttribute.CmRcptPhone<\/p>\n

                                      X-CMRCPTLICENSES<\/h3>\n

                                      MessageAttribute.CmRcptLicenses<\/p>\n

                                      X-CMRCPTFIRSTNAME<\/h3>\n

                                      MessageAttribute.CmRcptFirstName<\/p>\n

                                      X-CMRCPTCOMPANYNAME<\/h3>\n

                                      MessageAttribute.CmRcptCompanyName<\/p>\n

                                      X-CMRCPTLASTNAME<\/h3>\n

                                      MessageAttribute.CmRcptLastName<\/p>\n

                                      X-CMRCPTEXPDAYS<\/h3>\n

                                      MessageAttribute.CmRcptExpDays<\/p>\n

                                      X-CMRCPTCHECKSUM<\/h3>\n

                                      MessageAttribute.CmRcptChecksum<\/p>\n

                                      X-CMRcptHashType<\/h3>\n

                                      MessageAttribute.CmRcptHashType<\/p>\n","protected":false},"excerpt":{"rendered":"

                                      Headers & MessageAttributes All X-Headers that are currently used by DataMotion are described in this article. Each X-Header is its own section with the corresponding MessageAttribute and information contained in the text of the section. X-COBRAND MessageAttribute.CoBrand Not used in code. X-EMAILRECEIPT MessageAttribute.EmailReceipt Expected to be numeric: MessageReceipt.DontSend = 0…<\/p>\n","protected":false},"author":1,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"content-type":"","footnotes":""},"ht-kb-category":[181],"ht-kb-tag":[],"class_list":["post-4811","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-datamotion-apis"],"_links":{"self":[{"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=\/wp\/v2\/ht-kb\/4811","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=4811"}],"version-history":[{"count":8,"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=\/wp\/v2\/ht-kb\/4811\/revisions"}],"predecessor-version":[{"id":7896,"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=\/wp\/v2\/ht-kb\/4811\/revisions\/7896"}],"wp:attachment":[{"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=4811"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=%2Fwp%2Fv2%2Fht-kb-category&post=4811"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/knowlegebase-b5heb6b2esbghgd4.eastus2-01.azurewebsites.net\/index.php?rest_route=%2Fwp%2Fv2%2Fht-kb-tag&post=4811"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}