DELETE api/2.0/crm/contact/filter
Deletes a list of all the contacts in the CRM module matching the parameters specified in the request.
Name |
Description |
Type |
Example |
tags
sent in body
|
Contact tags
optional
|
Collection of strings
collection
|
some text
|
contactStage
sent in body
|
Contact stage ID (warmth)
optional
|
number
|
1234
|
contactType
sent in body
|
Contact type ID
optional
|
number
|
1234
|
contactListView
sent in body
|
Contact list view
Allowed values: Company, Person, WithOpportunity
optional
|
All, Company, Person, WithOpportunity
|
|
fromDate
sent in body
|
Start date
optional
|
Date and Time
|
Roundtrip format: 2008-04-10T06-30-00.000Z
|
toDate
sent in body
|
End date
optional
|
Date and Time
|
Roundtrip format: 2008-04-10T06-30-00.000Z
|
DELETE api/2.0/crm/contact/filter
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"tags": [
"some text"
],
"contactStage": 1234,
"contactType": 1234,
"contactListView": "company",
"fromDate": "2008-04-10T06-30-00.000Z",
"toDate": "2008-04-10T06-30-00.000Z"
}
application/json
{
"status": 0,
"response": [
{
"SmallFotoUrl": "url to foto",
"MediumFotoUrl": "url to foto",
"DisplayName": "Tadjeddine Bachir",
"IsCompany": false,
"AccessList": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
}
],
"IsPrivate": true,
"IsShared": false,
"ShareType": 0,
"Currency": {
"Title": "Chinese Yuan",
"Symbol": "¥",
"Abbreviation": "CNY",
"CultureName": "CN",
"IsConvertable": true,
"IsBasic": false
},
"CanEdit": true,
"CanDelete": true,
"id": 1234
}
]
}
text/xml
<result>
<status>0</status>
<response>
<SmallFotoUrl>url to foto</SmallFotoUrl>
<MediumFotoUrl>url to foto</MediumFotoUrl>
<DisplayName>Tadjeddine Bachir</DisplayName>
<IsCompany>False</IsCompany>
<AccessList>
<Id>00000000-0000-0000-0000-000000000000</Id>
<DisplayName>Mike Zanyatski</DisplayName>
<Title>Manager</Title>
<AvatarSmall>url to small avatar</AvatarSmall>
<ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</AccessList>
<IsPrivate>True</IsPrivate>
<IsShared>False</IsShared>
<ShareType>0</ShareType>
<Currency>
<Title>Chinese Yuan</Title>
<Symbol>¥</Symbol>
<Abbreviation>CNY</Abbreviation>
<CultureName>CN</CultureName>
<IsConvertable>True</IsConvertable>
<IsBasic>False</IsBasic>
</Currency>
<CanEdit>True</CanEdit>
<CanDelete>True</CanDelete>
<id>1234</id>
</response>
</result>