...
...
Overview
The following operations allow you to work with cases. Click an operation name to see details on how to use it.
For a sample proxy service that illustrates how to work with cases, see Sample configuration.
Operation details
This section provides further details on the operations related to cases.
Creating a caseThe createCase
operation adds a new case.
Code Block |
---|
language | xml |
---|
title | createCase |
---|
|
<clevertimcrm.createCase>
<tags>{$ctx:tags}</tags>
<customFields>{$ctx:customFields}</customFields>
<description>{$ctx:description}</description>
<name>{$ctx:name}</name>
<leadUser>{$ctx:leadUser}</leadUser>
<customer>{$ctx:customer}</customer>
</clevertimcrm.createCase>
|
Properties
tags:
The tags associated with the case.customFields:
The custom fields associated with the case.description:
The description of the case.name:
The name of the case.leadUser:
The lead user of the case.customer:
The customer belonging to the case.
Sample requestFollowing is a sample REST/JSON request that can be handled by the createCase
operation.
Code Block |
---|
language | xml |
---|
title | Sample Request for createCase |
---|
|
{
"apiUrl":"https://www.clevertim.com",
"apiKey":"7hRfxQ3mXxLrnAmiIYxSIsFTlGdCYNfnqjY4pXtaAhYEe04HP3Z11751",
"name":"testSOAPCase7",
"description":"first description",
"tags": ["case", "support", "open"],
"customFields": {"460": "user1", "461": "user2"},
"leadUser": 11752,
"customer": 117010
}
|
https://github.com/clevertim/clevertim-crm-api/blob/master/resources/case.md#add-a-new-case
Updating a caseThe updateCase
operation updates the specified case.
Code Block |
---|
language | xml |
---|
title | updateCases |
---|
|
<clevertimcrm.updateCase>
<tags>{$ctx:tags}</tags>
<id>{$ctx:id}</id>
<customFields>{$ctx:customFields}</customFields>
<description>{$ctx:description}</description>
<name>{$ctx:name}</name>
<leadUser>{$ctx:leadUser}</leadUser>
<customer>{$ctx:customer}</customer>
</clevertimcrm.updateCase>
|
Properties
tags:
The tags associated with the case.id:
The ID of the case.customFields:
The custom fields associated with the case.description:
The description of the case.name:
The name of the case.leadUser:
The lead user of the case.customer:
The customer who belongs to the case.
Sample request
Following is a sample REST/JSON request that can be handled by the updateCase
operation.
Code Block |
---|
language | xml |
---|
title | updateCase |
---|
|
{
"apiUrl":"https://www.clevertim.com",
"apiKey":"tPnLGkETTPFbxfu0oIJtchPDxzBWzXaTSOStS4B6aGHIszKFrCZ11557",
"id":"22019",
"description":"Second description"
}
|
https://github.com/clevertim/clevertim-crm-api/blob/master/resources/case.md#update-an-existing-case
Listing casesThe listCases
operation retrieves all cases.
Code Block |
---|
language | xml |
---|
title | listCases |
---|
|
<clevertimcrm.listCases/> |
Sample request
Following is a sample REST/JSON request that can be handled by the listCases
operation.
Code Block |
---|
language | xml |
---|
title | listCases |
---|
|
{
"apiUrl":"https://www.clevertim.com",
"apiKey":"tPnLGkETTPFbxfu0oIJtchPDxzBWzXaTSOStS4B6aGHIszKFrCZ11557"
} |
https://github.com/clevertim/clevertim-crm-api/blob/master/resources/case.md#get-all-cases
Sample configuration
Following is a sample proxy service that illustrates how to connect to Clevertim CRM with the init
operation and use the createCase
operation. The sample request for this proxy can be found in createCase sample request. You can use this sample as a template for using other operations in this category.
...