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": null,
"contactType": null,
"contactListView": "all",
"fromDate": "2008-04-10T06-30-00.000Z",
"toDate": "2008-04-10T06-30-00.000Z"
}
application/json
{
"status": 0,
"response": [
{
"smallFotoUrl": "url to foto",
"displayName": "Tadjeddine Bachir",
"isCompany": false,
"isPrivate": true,
"isShared": false,
"shareType": 0,
"currency": null,
"canEdit": false,
"canDelete": false,
"id": 0
}
]
}
text/xml
<result>
<status>0</status>
<response>
<smallFotoUrl>url to foto</smallFotoUrl>
<displayName>Tadjeddine Bachir</displayName>
<isCompany>false</isCompany>
<isPrivate>true</isPrivate>
<isShared>false</isShared>
<shareType>0</shareType>
<currency />
<canEdit>false</canEdit>
<canDelete>false</canDelete>
<id>0</id>
</response>
</result>