POST {version}/DeleteContactFilter
Delete Contact Filter
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
FilterName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
ExpressionId | globally unique identifier |
None. |
|
Description | string |
None. |
|
Internal | boolean |
None. |
|
Inactive | boolean |
None. |
|
CreatedOn | date |
None. |
|
UpdatedOn | date |
None. |
|
LastModifiedOn | date |
None. |
|
ToBeDeleted | boolean |
None. |
|
SubOptions | Collection of FilterOptionDefinitionSubOption |
None. |
|
Columns | Collection of FilterColumnAssociation |
None. |
|
DataFilter | string |
None. |
|
SortCol | string |
None. |
|
SortAsc | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "58c131c5-386c-44d1-ba0d-42d327b067f4", "Name": "sample string 2", "ExpressionId": "a1441fd2-9fa3-4e83-b388-61a5914a738f", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "04/03/2025", "UpdatedOn": "04/03/2025", "LastModifiedOn": "04/03/2025", "ToBeDeleted": true, "SubOptions": [ { "Id": "0eb95172-6262-4c12-a93c-42bc17ac57de", "DefId": "1e30be03-2ebc-44e2-b6e2-a937b24b869e", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "0eb95172-6262-4c12-a93c-42bc17ac57de", "DefId": "1e30be03-2ebc-44e2-b6e2-a937b24b869e", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "91fee690-1feb-45a6-a07e-d317cb2d9465", "FilterId": "ef44bdd8-c227-43e4-8565-87b260237073", "ColumnId": "f87da4a8-bb5c-4827-81dd-de62ac13ce06", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "91fee690-1feb-45a6-a07e-d317cb2d9465", "FilterId": "ef44bdd8-c227-43e4-8565-87b260237073", "ColumnId": "f87da4a8-bb5c-4827-81dd-de62ac13ce06", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true }
application/xml, text/xml
Sample:
<Filter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <Columns> <FilterColumnAssociation> <ColumnId>f87da4a8-bb5c-4827-81dd-de62ac13ce06</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>ef44bdd8-c227-43e4-8565-87b260237073</FilterId> <Id>91fee690-1feb-45a6-a07e-d317cb2d9465</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>f87da4a8-bb5c-4827-81dd-de62ac13ce06</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>ef44bdd8-c227-43e4-8565-87b260237073</FilterId> <Id>91fee690-1feb-45a6-a07e-d317cb2d9465</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2025-04-03T05:00:48.0660315-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>a1441fd2-9fa3-4e83-b388-61a5914a738f</ExpressionId> <Id>58c131c5-386c-44d1-ba0d-42d327b067f4</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>1e30be03-2ebc-44e2-b6e2-a937b24b869e</DefId> <Id>0eb95172-6262-4c12-a93c-42bc17ac57de</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>1e30be03-2ebc-44e2-b6e2-a937b24b869e</DefId> <Id>0eb95172-6262-4c12-a93c-42bc17ac57de</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> </SubOptions> <ToBeDeleted>true</ToBeDeleted> <UpdatedOn>2025-04-03T05:00:48.0660315-04:00</UpdatedOn> </Filter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |