POST api/list/events/savefilter

Save Event Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The save event list filter data contract supplied with the request.

SaveEventListFilterDataContract

Name	Description	Type	Additional information
Context	The context classification.	ListContext	None.
CreatedBy	The collection of created by.	Collection of integer	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
OwningTeamIds	The unique identifiers of the related owning team resources.	Collection of integer	None.
RoleIds	The unique identifiers of the related role resources.	Collection of integer	None.
GroupId	The unique identifier of the related group resource.	integer	None.
From	The from, expressed as a date and time.	date	None.
To	The to, expressed as a date and time.	date	None.
Date	The date value.	DateRangeFilterDataContract	None.
UpcomingOnly	Indicates whether upcoming only is true.	boolean	None.
CreatedFrom	The created from, expressed as a date and time.	date	None.
CreatedTo	The created to, expressed as a date and time.	date	None.
Created	The created value.	DateRangeFilterDataContract	None.
OfferStatuses	The collection of offer statuses.	Collection of EnumDataContract	None.
EventCategories	The collection of event categories.	Collection of EnumDataContract	None.
EventTypes	The collection of event types.	Collection of EnumDataContract	None.
EventStatuses	The collection of event statuses.	Collection of EnumDataContract	None.
IncludeDrafts	Indicates whether include drafts is true.	boolean	None.
IncludeOnlyOriginalNotes	Indicates whether include only original notes is true.	boolean	None.
ExcludedRevisedOffers	Indicates whether excluded revised offers is true.	boolean	None.
ExcludedTypes	The collection of excluded types.	Collection of EnumDataContract	None.
RoleTypes	The collection of role types.	Collection of string	None.
ExcludeRoleTypes	The collection of exclude role types.	Collection of string	None.
RoleStatuses	The collection of role statuses.	Collection of string	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
Descriptions	The collection of descriptions.	Dictionary of string [key] and string [value]	None.
FeedbackTaken	Indicates whether feedback taken is true.	boolean	None.
FeedbackReported	Indicates whether feedback reported is true.	boolean	None.
MethodsOfContact	The collection of methods of contact.	Collection of EnumDataContract	None.
SortType	The sort type classification.	EventListSortType	None.
EventIds	The unique identifiers of the related event resources.	Collection of integer	None.
AdditionalIds	The unique identifiers of the related additional resources.	Collection of integer	None.
ExcludedIds	The unique identifiers of the related excluded resources.	Collection of integer	None.
CleanInactiveAppointments	Indicates whether clean inactive appointments is true.	boolean	None.
UseMinimalMapping	Indicates whether use minimal mapping is true.	boolean	None.
FilterNotes	Indicates whether filter notes is true.	boolean	None.
Name	The name value.	string	None.
CustomFilterConfig	The custom filter config value.	string	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
EventBranchIds	The unique identifiers of the related event branch resources.	Collection of integer	None.
Order	The order classification.	ListOrder	None.
SearchTerm	The search term value.	string	None.
FilterType	The filter type value.	EnumDataContract	None.
ShowDeleted	Indicates whether show deleted is true.	boolean	None.
ShowCancelled	Indicates whether show cancelled is true.	boolean	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Context": 0,
  "CreatedBy": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    1
  ],
  "OwningTeamIds": [
    1,
    1
  ],
  "RoleIds": [
    1,
    2
  ],
  "GroupId": 1,
  "From": "2026-08-05T00:19:56.4098031Z",
  "To": "2026-08-05T00:19:56.4098031Z",
  "Date": {
    "FromStaticDate": "2026-08-05T00:19:56.4098031Z",
    "ToStaticDate": "2026-08-05T00:19:56.4098031Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpcomingOnly": true,
  "CreatedFrom": "2026-08-05T00:19:56.4098031Z",
  "CreatedTo": "2026-08-05T00:19:56.4098031Z",
  "Created": {
    "FromStaticDate": "2026-08-05T00:19:56.4098031Z",
    "ToStaticDate": "2026-08-05T00:19:56.4098031Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventCategories": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IncludeDrafts": true,
  "IncludeOnlyOriginalNotes": true,
  "ExcludedRevisedOffers": true,
  "ExcludedTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeRoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "PropertyId": 1,
  "Descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "FeedbackTaken": true,
  "FeedbackReported": true,
  "MethodsOfContact": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "SortType": 0,
  "EventIds": [
    1,
    2
  ],
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "CleanInactiveAppointments": true,
  "UseMinimalMapping": true,
  "FilterNotes": true,
  "Name": "sample string 8",
  "CustomFilterConfig": "sample string 9",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 10",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 13,
  "Id": 14
}

Response Information

Resource Description

The response returned after the operation completes.

EventListFilterDataContract

Name	Description	Type	Additional information
CreatedBy	The collection of created by.	Collection of integer	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
OwningTeamIds	The unique identifiers of the related owning team resources.	Collection of integer	None.
RoleIds	The unique identifiers of the related role resources.	Collection of integer	None.
GroupId	The unique identifier of the related group resource.	integer	None.
From	The from, expressed as a date and time.	date	None.
To	The to, expressed as a date and time.	date	None.
Date	The date value.	DateRangeFilterDataContract	None.
UpcomingOnly	Indicates whether upcoming only is true.	boolean	None.
CreatedFrom	The created from, expressed as a date and time.	date	None.
CreatedTo	The created to, expressed as a date and time.	date	None.
Created	The created value.	DateRangeFilterDataContract	None.
OfferStatuses	The collection of offer statuses.	Collection of EnumDataContract	None.
EventCategories	The collection of event categories.	Collection of EnumDataContract	None.
EventTypes	The collection of event types.	Collection of EnumDataContract	None.
EventStatuses	The collection of event statuses.	Collection of EnumDataContract	None.
IncludeDrafts	Indicates whether include drafts is true.	boolean	None.
IncludeOnlyOriginalNotes	Indicates whether include only original notes is true.	boolean	None.
ExcludedRevisedOffers	Indicates whether excluded revised offers is true.	boolean	None.
ExcludedTypes	The collection of excluded types.	Collection of EnumDataContract	None.
RoleTypes	The collection of role types.	Collection of string	None.
ExcludeRoleTypes	The collection of exclude role types.	Collection of string	None.
RoleStatuses	The collection of role statuses.	Collection of string	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
Descriptions	The collection of descriptions.	Dictionary of string [key] and string [value]	None.
FeedbackTaken	Indicates whether feedback taken is true.	boolean	None.
FeedbackReported	Indicates whether feedback reported is true.	boolean	None.
MethodsOfContact	The collection of methods of contact.	Collection of EnumDataContract	None.
SortType	The sort type classification.	EventListSortType	None.
EventIds	The unique identifiers of the related event resources.	Collection of integer	None.
AdditionalIds	The unique identifiers of the related additional resources.	Collection of integer	None.
ExcludedIds	The unique identifiers of the related excluded resources.	Collection of integer	None.
CleanInactiveAppointments	Indicates whether clean inactive appointments is true.	boolean	None.
UseMinimalMapping	Indicates whether use minimal mapping is true.	boolean	None.
FilterNotes	Indicates whether filter notes is true.	boolean	None.
Name	The name value.	string	None.
CustomFilterConfig	The custom filter config value.	string	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
EventBranchIds	The unique identifiers of the related event branch resources.	Collection of integer	None.
Order	The order classification.	ListOrder	None.
SearchTerm	The search term value.	string	None.
FilterType	The filter type value.	EnumDataContract	None.
ShowDeleted	Indicates whether show deleted is true.	boolean	None.
ShowCancelled	Indicates whether show cancelled is true.	boolean	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CreatedBy": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    1
  ],
  "OwningTeamIds": [
    1,
    1
  ],
  "RoleIds": [
    1,
    2
  ],
  "GroupId": 1,
  "From": "2026-08-05T00:19:56.4254268Z",
  "To": "2026-08-05T00:19:56.4254268Z",
  "Date": {
    "FromStaticDate": "2026-08-05T00:19:56.4254268Z",
    "ToStaticDate": "2026-08-05T00:19:56.4254268Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpcomingOnly": true,
  "CreatedFrom": "2026-08-05T00:19:56.4254268Z",
  "CreatedTo": "2026-08-05T00:19:56.4254268Z",
  "Created": {
    "FromStaticDate": "2026-08-05T00:19:56.4254268Z",
    "ToStaticDate": "2026-08-05T00:19:56.4254268Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventCategories": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "EventStatuses": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IncludeDrafts": true,
  "IncludeOnlyOriginalNotes": true,
  "ExcludedRevisedOffers": true,
  "ExcludedTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeRoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "PropertyId": 1,
  "Descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "FeedbackTaken": true,
  "FeedbackReported": true,
  "MethodsOfContact": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "SortType": 0,
  "EventIds": [
    1,
    2
  ],
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "CleanInactiveAppointments": true,
  "UseMinimalMapping": true,
  "FilterNotes": true,
  "Name": "sample string 8",
  "CustomFilterConfig": "sample string 9",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 10",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 13,
  "Id": 14
}