Delete contacts by parameters
DELETE /api/2.0/crm/contact/filter
Request
Deletes a list of all the contacts in the CRM module matching the parameters specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Body
- tags
array of string
Contact tags
- contactStage
array of integer
Contact stage ID (warmth)
- contactType
array of integer
Contact type ID
- contactListView
integer
Contact list view
- fromDate
string
Start date
- toDate
string
End date
Examples
DELETE /api/2.0/crm/contact/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request DELETE \
--url https://example.com/api/2.0/crm/contact/filter \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
List of contacts
- SmallFotoUrl
string
- MediumFotoUrl
string
- DisplayName
string
- IsCompany
boolean
- AccessList
array of object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- IsPrivate
boolean
- IsShared
boolean
- ShareType
enum of integer
int32 [0 - None, 1 - ReadWrite, 2 - Read]
Can be one of:
None
,ReadWrite
,Read
.- Currency
object
- Title
string
- Symbol
string
- Abbreviation
string
- CultureName
string
- IsConvertable
boolean
- IsBasic
boolean
- CanEdit
boolean
- CanDelete
boolean
- ID
integer
int32
401
Unauthorized