CRM Communication
|
URL |
Verbs |
Function |
Available |
|---|---|---|---|
|
/CRMCommunication |
GET |
Query a list of CRM Communications |
2019.1 |
| /CRMCommunication | POST | Create a new CRM Communication | 2019.3 |
|
/CRMCommunication<code> |
GET |
Query a single CRM Communication |
2019.1 |
| /CRMCommunication<code> | POST | Update an existing CRM Communication | 2019.3 |
Supported modifiers
|
Query String |
Definition |
Sample
|
Available |
|---|---|---|---|
| serviceRequest | Query Communications for a specific Service Request | serviceRequest=52445 | 2020.1 |
| lead | Query Communications for a specific Lead | lead=35566 | 2020.1 |
| organisation | Query Communications for a specific Organisation | organisation=24454 | 2020.1 |
| contact | Query Communications for a specific Contact | contact=64345 | 2020.1 |
| campaign | Query Communications for a specific Campaign | campaign=56443 | 2020.1 |
| product | Query Communications for a specific Product | product=454566 | 2020.1 |
| stage | Query Communications that are set to a particular Stage (or Status as its known on screen) | stage=OPEN | 2020.1 |
| priority | Query Communications for a specific Priority | priority=LOW | 2020.1 |
| source | Query Communications for a specific Source | source=LETTER | 2020.1 |
| direction | Query Communications for a specific direction - values are "Inbound" and "Outbound" | direction=Inbound | 2020.1 |
| modifiedSince | Query Communications modified since a nominated date and time | modifiedSince=2013-02-28T16:45:00 | 2020.1 |
| type | Query Communications for a specific Type | type=Service | 2020.1 |
Security Linked Menu
|
Menu Item
|
Located
|
|---|---|
| Communications | CRM / Relationships |
| Communications | CRM / Sales & Marketing |
| Communications | CRM / Service & Support |
| Communications | CRM / Bookings Management |
| Communications | CRM / Debt Collection |
| Communications | CRM / Fund Raising |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<CRMCommunication>
<OidString>5504.1</OidString>
<Edition>8</Edition>
<CommunicationNumber>1000</CommunicationNumber>
<Detail>SUPER 4/1/2008, 09:31:25 - Phoned Lisa to introduce myself and highlight our product range available. Will send out brochures.</Detail>
<Direction>Outbound</Direction>
<EntryTimestamp>2008-01-06T09:32:21</EntryTimestamp>
<EntryUser>SUPER</EntryUser>
<IsColdCall>true</IsColdCall>
<IsConnectionSucessfull>true</IsConnectionSucessfull>
<IsPrivate>false</IsPrivate>
<IsWebAccessible>false</IsWebAccessible>
<ModifiedTimestamp>2011-09-23T11:00:44</ModifiedTimestamp>
<ModifiedUser>SUPER</ModifiedUser>
<AssignedTeam>Admin Team</AssignedTeam>
<AssignedUser>Angela Allen</AssignedUser>
<Organisation>1000</Organisation>
<Contact>10000</Contact>
<Campaign>1000</Campaign>
<Stage>OPEN</Stage>
<PrimaryProduct>1001</PrimaryProduct>
<Priority>MEDIUM</Priority>
<Source>CALL</Source>
<OpenDate>2008-01-04</OpenDate>
<OpenedBy>SUPER</OpenedBy>
<OutlookWindowsName/>
<SourceDetail/>
<Summary>Introductory Call</Summary>
<TimeSpent>00:01:48</TimeSpent>
<Type>General</Type>
</CRMCommunication>