POST 3dCartWebAPI/v1/CRM

Adds a new CRM to the system

Request Information

URI Parameters

None.

Body Parameters

A Json or XML object containing the new CRM

CRM

Name	Description	Type	Additional information
CrmID	Primary key. Auto-incremented. database reference = CRM.id	integer	None.
DateOpened	database reference = CRM.datentime	date	None.
DateLastAction	database reference = CRM.lastactiondatentime	date	None.
Subject	database reference = CRM.subject	string	String length: inclusive between 0 and 50
DepartmentID	database reference = CRM.departmentid	integer	None.
StatusID	database reference = CRM.status	integer	None.
CustomerName	database reference = CRM.customer	string	String length: inclusive between 0 and 255
CustomerEmail	database reference = CRM.custemail	string	Required String length: inclusive between 0 and 100
CustomerPhone	database reference = CRM.phone	string	String length: inclusive between 0 and 50
CustomerIpAddress	database reference = CRM.custip	string	String length: inclusive between 0 and 50
OrderID	database reference = CRM.orderid	integer	None.
CustomerID	database reference = CRM.custid	integer	None.
ProductId	database reference = CRM.productid	integer	None.
CrmMessageList		Collection of CrmMessage	None.

Request Formats

application/json, text/json

Sample:

{
  "CrmID": 1,
  "DateOpened": "04/18/2024 03:05",
  "DateLastAction": "04/18/2024 03:05",
  "Subject": "sample string 1",
  "DepartmentID": 1,
  "StatusID": 1,
  "CustomerName": "sample string 2",
  "CustomerEmail": "sample string 3",
  "CustomerPhone": "sample string 4",
  "CustomerIpAddress": "sample string 5",
  "OrderID": 1,
  "CustomerID": 1,
  "ProductId": 1,
  "CrmMessageList": [
    {
      "MessageId": 1,
      "DateCreated": "04/18/2024 03:05",
      "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": "04/18/2024 03:05",
          "IsAdminUploaded": true
        },
        {
          "FileId": 1,
          "FileName": "sample string 1",
          "DateCreated": "04/18/2024 03:05",
          "IsAdminUploaded": true
        }
      ]
    },
    {
      "MessageId": 1,
      "DateCreated": "04/18/2024 03:05",
      "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": "04/18/2024 03:05",
          "IsAdminUploaded": true
        },
        {
          "FileId": 1,
          "FileName": "sample string 1",
          "DateCreated": "04/18/2024 03:05",
          "IsAdminUploaded": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<CRM xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CrmID>1</CrmID>
  <DateOpened>2024-04-18T03:05:25.2484362-04:00</DateOpened>
  <DateLastAction>2024-04-18T03:05:25.2484362-04:00</DateLastAction>
  <Subject>sample string 1</Subject>
  <DepartmentID>1</DepartmentID>
  <StatusID>1</StatusID>
  <CustomerName>sample string 2</CustomerName>
  <CustomerEmail>sample string 3</CustomerEmail>
  <CustomerPhone>sample string 4</CustomerPhone>
  <CustomerIpAddress>sample string 5</CustomerIpAddress>
  <OrderID>1</OrderID>
  <CustomerID>1</CustomerID>
  <ProductId>1</ProductId>
  <CrmMessageList>
    <CrmMessage>
      <MessageId>1</MessageId>
      <DateCreated>2024-04-18T03:05:25.2484362-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>2024-04-18T03:05:25.2484362-04:00</DateCreated>
          <IsAdminUploaded>true</IsAdminUploaded>
        </CrmFile>
        <CrmFile>
          <FileId>1</FileId>
          <FileName>sample string 1</FileName>
          <DateCreated>2024-04-18T03:05:25.2484362-04:00</DateCreated>
          <IsAdminUploaded>true</IsAdminUploaded>
        </CrmFile>
      </CrmFileList>
    </CrmMessage>
    <CrmMessage>
      <MessageId>1</MessageId>
      <DateCreated>2024-04-18T03:05:25.2484362-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>2024-04-18T03:05:25.2484362-04:00</DateCreated>
          <IsAdminUploaded>true</IsAdminUploaded>
        </CrmFile>
        <CrmFile>
          <FileId>1</FileId>
          <FileName>sample string 1</FileName>
          <DateCreated>2024-04-18T03:05:25.2484362-04:00</DateCreated>
          <IsAdminUploaded>true</IsAdminUploaded>
        </CrmFile>
      </CrmFileList>
    </CrmMessage>
  </CrmMessageList>
</CRM>

Sample Request

PHP

Python

Ruby

Response Information

application/json, text/json

Sample:

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

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.