POST 3dCartWebAPI/v1/CRM/{id}/message


Adds a new CRM Message to the system

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id of the CRM where the message will be added

integer

Default value is 0

Body Parameters

A Json or XML object containing the new CRM message

CrmMessage
NameDescriptionTypeAdditional information
MessageId

Primary key. Auto-incremented. database reference = CRM_messages.id

integer

None.

DateCreated

database reference = CRM_messages.datentime

date

None.

Message

database reference = CRM_messages.message

string

String length: inclusive between 0 and 65535

Sender

database reference = CRM_messages.sender

integer

None.

SenderName

database reference = CRM_messages.sendername

string

String length: inclusive between 0 and 150

SenderEmail

database reference = CRM_messages.senderemail

string

String length: inclusive between 0 and 100

CustomerIPAddress

database reference = CRM_messages.custip

string

String length: inclusive between 0 and 16

CrmFileList

Collection of CrmFile

None.

Request Formats

application/json, text/json

Sample:
{
  "MessageId": 1,
  "DateCreated": "08/17/2019 16:31",
  "Message": "sample string 1",
  "Sender": 1,
  "SenderName": "sample string 2",
  "SenderEmail": "sample string 3",
  "CustomerIPAddress": "sample string 4",
  "CrmFileList": [
    {
      "FileId": 1,
      "FileName": "sample string 1",
      "DateCreated": "08/17/2019 16:31",
      "IsAdminUploaded": true
    },
    {
      "FileId": 1,
      "FileName": "sample string 1",
      "DateCreated": "08/17/2019 16:31",
      "IsAdminUploaded": true
    }
  ]
}

application/xml, text/xml

Sample:
<CrmMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessageId>1</MessageId>
  <DateCreated>2019-08-17T16:31:58.6662908-04:00</DateCreated>
  <Message>sample string 1</Message>
  <Sender>1</Sender>
  <SenderName>sample string 2</SenderName>
  <SenderEmail>sample string 3</SenderEmail>
  <CustomerIPAddress>sample string 4</CustomerIPAddress>
  <CrmFileList>
    <CrmFile>
      <FileId>1</FileId>
      <FileName>sample string 1</FileName>
      <DateCreated>2019-08-17T16:31:58.6662908-04:00</DateCreated>
      <IsAdminUploaded>true</IsAdminUploaded>
    </CrmFile>
    <CrmFile>
      <FileId>1</FileId>
      <FileName>sample string 1</FileName>
      <DateCreated>2019-08-17T16:31:58.6662908-04:00</DateCreated>
      <IsAdminUploaded>true</IsAdminUploaded>
    </CrmFile>
  </CrmFileList>
</CrmMessage>

Sample Request



Response Information

application/json, text/json

Sample:
[
  {
    "Key":"MessageId",
    "Value":"1234",
    "Status":"201",
    "Message":"Created successfully",
  }
]
							

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.