POST api/progression/bulkwithdrawvaluations

Bulk withdrawal valuations from a property role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The bulk withdraw instruction data contract supplied with the request.

BulkWithdrawInstructionDataContract

Name	Description	Type	Additional information
Filter	The filter value.	EventListFilterDataContract	None.
Ids	The unique identifiers of the related api resources.	Collection of integer	None.
ExcludedIds	The unique identifiers of the related excluded resources.	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Filter": {
    "CreatedBy": [
      1,
      2
    ],
    "NegotiatorIds": [
      1,
      1
    ],
    "OwningTeamIds": [
      1,
      1
    ],
    "RoleIds": [
      1,
      2
    ],
    "GroupId": 1,
    "From": "2026-07-23T10:36:49.3558769Z",
    "To": "2026-07-23T10:36:49.3558769Z",
    "Date": {
      "FromStaticDate": "2026-07-23T10:36:49.3558769Z",
      "ToStaticDate": "2026-07-23T10:36:49.3558769Z",
      "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-07-23T10:36:49.3558769Z",
    "CreatedTo": "2026-07-23T10:36:49.3558769Z",
    "Created": {
      "FromStaticDate": "2026-07-23T10:36:49.3558769Z",
      "ToStaticDate": "2026-07-23T10:36:49.3558769Z",
      "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
  },
  "Ids": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract

Name	Description	Type	Additional information
SupportsCancellation	Indicates whether supports cancellation is true.	boolean	None.
ReportsProgress	Indicates whether reports progress is true.	boolean	None.
InitialStatusText	The initial status text value.	string	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
Success	Indicates whether success is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "3a44b4f9-818b-46d8-b366-1105c59ea607",
  "Success": true
}