POST api/group/archivegroups

Archive groups in bulk

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Group.Command.Delete.GroupBulkArchiveCommandDataContract

Name	Type	Additional information
Filter	Dezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListFilterDataContract	None.
Ids	Collection of integer	None.
ExcludedIds	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Filter": {
    "InterestFlags": [
      "sample string 1",
      "sample string 2"
    ],
    "Origins": [
      "sample string 1",
      "sample string 2"
    ],
    "Grades": [
      "sample string 1",
      "sample string 2"
    ],
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "RoleStatuses": [
      "sample string 1",
      "sample string 2"
    ],
    "LastContactedFrom": "2024-11-21T09:58:01.6023502Z",
    "LastContactedTo": "2024-11-21T09:58:01.6023502Z",
    "LastContacted": {
      "FromStaticDate": "2024-11-21T09:58:01.6023502Z",
      "ToStaticDate": "2024-11-21T09:58:01.6023502Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CreatedFrom": "2024-11-21T09:58:01.6023502Z",
    "CreatedTo": "2024-11-21T09:58:01.6023502Z",
    "Created": {
      "FromStaticDate": "2024-11-21T09:58:01.6023502Z",
      "ToStaticDate": "2024-11-21T09:58:01.6023502Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "LandlordVendorFrom": "2024-11-21T09:58:01.6023502Z",
    "LandlordVendorTo": "2024-11-21T09:58:01.6023502Z",
    "LandlordVendor": {
      "FromStaticDate": "2024-11-21T09:58:01.6023502Z",
      "ToStaticDate": "2024-11-21T09:58:01.6023502Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "Sort": 0,
    "GroupIds": [
      1,
      2
    ],
    "OwningTeamIds": [
      1,
      2
    ],
    "RoleIds": [
      1,
      2
    ],
    "AdditionalIds": [
      1,
      2
    ],
    "ExcludedIds": [
      1,
      2
    ],
    "ExcludeHasNoEmail": true,
    "IsMarketingRoleTypeSearch": true,
    "HasValuationBooked": true,
    "HasSearch": true,
    "CompanyTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "Archived": true,
    "Name": "sample string 2",
    "CustomFilterConfig": "sample string 3",
    "BranchId": 1,
    "BranchIds": [
      1,
      2
    ],
    "EventBranchIds": [
      1,
      2
    ],
    "Order": 0,
    "SearchTerm": "sample string 4",
    "FilterType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ShowDeleted": true,
    "ShowCancelled": true,
    "OwningTeamId": 7,
    "Id": 8
  },
  "Ids": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ]
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract

Name	Type	Additional information
SupportsCancellation	boolean	None.
ReportsProgress	boolean	None.
InitialStatusText	string	None.
JobReference	globally unique identifier	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "3d521bb7-95dd-4dd4-81b2-e1bd35fc67cf",
  "Success": true
}