POST api/group/archivegroups

Archive groups in bulk

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Filter	GroupInterestListFilterDataContract	None.
Ids	Collection of integer	None.
ExcludedIds	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GroupBulkArchiveCommandDataContract'.

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": "2025-07-03T14:59:48.1903831Z",
    "LastContactedTo": "2025-07-03T14:59:48.1903831Z",
    "LastContacted": {
      "FromStaticDate": "2025-07-03T14:59:48.1903831Z",
      "ToStaticDate": "2025-07-03T14:59:48.1903831Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CreatedFrom": "2025-07-03T14:59:48.1903831Z",
    "CreatedTo": "2025-07-03T14:59:48.1903831Z",
    "Created": {
      "FromStaticDate": "2025-07-03T14:59:48.1903831Z",
      "ToStaticDate": "2025-07-03T14:59:48.1903831Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "LandlordVendorFrom": "2025-07-03T14:59:48.1903831Z",
    "LandlordVendorTo": "2025-07-03T14:59:48.1903831Z",
    "LandlordVendor": {
      "FromStaticDate": "2025-07-03T14:59:48.1903831Z",
      "ToStaticDate": "2025-07-03T14:59:48.1903831Z",
      "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

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": "e5bb92fe-f305-4cd4-b20b-9346a443e224",
  "Success": true
}