POST api/v1/InteractionCreate

Create a new customer interaction in Caliq. Must be created on an already existing customer

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
ChannelID	List of channels can be retrieved via API	integer	Required
CustomerID	Caliq internal unique customer identifier. Required if AccountNo not set	integer	None.
AccountNo	User entered unique customer account number. Required if CustomerID not set	string	Required Max length: 10
ContactID	Caliq internal unique contact identifier of the person the interaction was with	integer	None.
UniqueID	GUID for this call to uniquely identify it. Must be set	string	Required
Kind	Interaction type (C)all, (E)mail, (V)isit	string	Required Max length: 1
ContactedBy	Employee ID of the person interacting with the customer	string	Required Max length: 10
ContactedFirstName	If ContactID is not set, first name of person interacted with	string	Required Max length: 50
ContactedSurname	If ContactID is not set, surname of person interacted with	string	Required Max length: 50
OnDateTime	Date/time the interaction took place	string	None.
Notes	Notes of the interaction	string	None.
FollowUpDateTime	Date/time of any follow up. Leave blank if no follow up	string	None.
FollowUpBy	Employee ID of the person to follow up with the customer. Leave empty if no follow up	string	Required Max length: 10
FollowUpNotes	Follow Up Notes	string	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "ChannelID": 2,
  "CustomerID": 3,
  "AccountNo": "sample string 4",
  "ContactID": 5,
  "UniqueID": "sample string 6",
  "Kind": "sample string 7",
  "ContactedBy": "sample string 8",
  "ContactedFirstName": "sample string 9",
  "ContactedSurname": "sample string 10",
  "OnDateTime": "sample string 11",
  "Notes": "sample string 12",
  "FollowUpDateTime": "sample string 13",
  "FollowUpBy": "sample string 14",
  "FollowUpNotes": "sample string 15"
}

application/xml, text/xml

Sample:

<InteractionCreateParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <ChannelID>2</ChannelID>
  <CustomerID>3</CustomerID>
  <AccountNo>sample string 4</AccountNo>
  <ContactID>5</ContactID>
  <UniqueID>sample string 6</UniqueID>
  <Kind>sample string 7</Kind>
  <ContactedBy>sample string 8</ContactedBy>
  <ContactedFirstName>sample string 9</ContactedFirstName>
  <ContactedSurname>sample string 10</ContactedSurname>
  <OnDateTime>sample string 11</OnDateTime>
  <Notes>sample string 12</Notes>
  <FollowUpDateTime>sample string 13</FollowUpDateTime>
  <FollowUpBy>sample string 14</FollowUpBy>
  <FollowUpNotes>sample string 15</FollowUpNotes>
</InteractionCreateParams>

Response Information

Resource Description

Returns:
200 OK
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

InteractionAddResults

Name	Description	Type	Additional information
InteractionAddData		InteractionAddData	None.

Response Formats

application/json, text/json

Sample:

{
  "InteractionAddData": {
    "OK": true,
    "InteractionCreateIssues": [
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      },
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<InteractionAddResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InteractionAddData>
    <OK>true</OK>
    <InteractionCreateIssues>
      <InteractionCreateIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </InteractionCreateIssue>
      <InteractionCreateIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </InteractionCreateIssue>
    </InteractionCreateIssues>
  </InteractionAddData>
</InteractionAddResults>