POST api/group/{id}/savesalessearch

Saves Search Criteria to a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the group	integer	Required

Body Parameters

The groups search criteria

SaveGroupSalesSearchingRoleDataContract

Name	Description	Type	Additional information
Id	The unique identifier of this resource.	integer	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
Description	The description value.	string	None.
Criteria	The criteria value.	GroupSearchCriteriaDataContract	None.
Grade	The grade value.	EnumDataContract	None.
Origin	The origin value.	EnumDataContract	None.
FinancialStatus	The financial status value.	EnumDataContract	None.
InActive	Indicates whether in active is true.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Id": 1,
  "OwningTeamId": 2,
  "BranchId": 3,
  "Description": "sample string 4",
  "Criteria": {
    "BudgetFrom": 1,
    "BudgetTo": 1,
    "NormalisedBudgetFrom": 2.1,
    "NormalisedBudgetTo": 1.1,
    "BudgetFlexible": true,
    "MustHave": {
      "MinimumBedrooms": 1,
      "MaximumBedrooms": 1,
      "Garage": true,
      "HasGarden": true,
      "MinimumReceptions": 4,
      "MinimumBathrooms": 5,
      "PropertyTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "PropertyTags": [
        {
          "Name": "sample string 1",
          "Id": 2
        },
        {
          "Name": "sample string 1",
          "Id": 2
        }
      ],
      "Regions": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        }
      ],
      "AddressId": 1
    },
    "ShouldHave": {
      "PropertyTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "PropertyTags": [
        {
          "Name": "sample string 1",
          "Id": 2
        },
        {
          "Name": "sample string 1",
          "Id": 2
        }
      ]
    },
    "ShouldNotHave": {
      "PropertyTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "PropertyTags": [
        {
          "Name": "sample string 1",
          "Id": 2
        },
        {
          "Name": "sample string 1",
          "Id": 2
        }
      ]
    },
    "MustNotHave": {
      "Regions": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        }
      ]
    }
  },
  "Grade": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Origin": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FinancialStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "InActive": true
}

Response Information

Resource Description

The created search criteria

GroupSalesSearchingRoleDataContract

Name	Description	Type	Additional information
Criteria	The criteria value.	GroupSearchCriteriaDataContract	None.
Grade	The grade value.	EnumDataContract	None.
Origin	The origin value.	EnumDataContract	None.
FinancialStatus	The financial status value.	EnumDataContract	None.
Description	The description value.	string	None.
DislikedRoles	The collection of disliked roles.	Collection of integer	None.
LikedRoles	The collection of liked roles.	Collection of integer	None.
ShouldRoles	The collection of should roles.	Collection of integer	None.
RoleStatus	The role status value.	EnumDataContract	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
GroupId	The unique identifier of the related group resource.	integer	None.
Name	The name value.	string	None.
TeamAccessType	The team access type value.	string	None.
RoleType	The role type value.	EnumDataContract	None.
CustomFields	The collection of custom fields.	Collection of CustomFieldGroupWithValuesDataContract	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Criteria": {
    "BudgetFrom": 1,
    "BudgetTo": 1,
    "NormalisedBudgetFrom": 2.1,
    "NormalisedBudgetTo": 1.1,
    "BudgetFlexible": true,
    "MustHave": {
      "MinimumBedrooms": 1,
      "MaximumBedrooms": 1,
      "Garage": true,
      "HasGarden": true,
      "MinimumReceptions": 4,
      "MinimumBathrooms": 5,
      "PropertyTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "PropertyTags": [
        {
          "Name": "sample string 1",
          "Id": 2
        },
        {
          "Name": "sample string 1",
          "Id": 2
        }
      ],
      "Regions": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        }
      ],
      "AddressId": 1
    },
    "ShouldHave": {
      "PropertyTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "PropertyTags": [
        {
          "Name": "sample string 1",
          "Id": 2
        },
        {
          "Name": "sample string 1",
          "Id": 2
        }
      ]
    },
    "ShouldNotHave": {
      "PropertyTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "PropertyTags": [
        {
          "Name": "sample string 1",
          "Id": 2
        },
        {
          "Name": "sample string 1",
          "Id": 2
        }
      ]
    },
    "MustNotHave": {
      "Regions": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Type": "sample string 3",
          "Source": "sample string 4"
        }
      ]
    }
  },
  "Grade": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Origin": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FinancialStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Description": "sample string 1",
  "DislikedRoles": [
    1,
    2
  ],
  "LikedRoles": [
    1,
    2
  ],
  "ShouldRoles": [
    1,
    2
  ],
  "RoleStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "OwningTeamId": 2,
  "BranchId": 3,
  "GroupId": 4,
  "Name": "sample string 5",
  "TeamAccessType": "sample string 6",
  "RoleType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "CustomFields": [
    {
      "Name": "sample string 1",
      "Values": [
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Values": [
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    }
  ],
  "CreatedDate": "2026-08-04T23:21:19.5958291Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 8
}