POST api/v1/portals/{portalUid}/users/{userUid}/savedsearches

Creates the saved search.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal GUID.	globally unique identifier	Required
userUid	The user GUID.	globally unique identifier	Required

Body Parameters

The saved search.

SavedSearch

Name	Description	Type	Additional information
Name	The name of the saved search.	string	Required String length: inclusive between 0 and 100
NotSetValue	The value given to returned NULL values.	string	String length: inclusive between 0 and 100
AnyValue	The value given to the select dropdown list.	string	String length: inclusive between 0 and 100
Countries	The countries.	string	String length: inclusive between 0 and 2048
Regions	The regions.	string	String length: inclusive between 0 and 2048
Locations	The locations.	string	String length: inclusive between 0 and 2048
Industries	The industries.	string	String length: inclusive between 0 and 2048
Disciplines	The disciplines.	string	String length: inclusive between 0 and 2048
SubDisciplines	The sub disciplines.	string	String length: inclusive between 0 and 2048
JobType	The type of the job.	string	String length: inclusive between 0 and 2048
PostedSince	The posted since.	date	None.
StartDate	The start date.	date	None.
Divisions	The divisions.	string	String length: inclusive between 0 and 2048
Classifications	The classifications.	string	String length: inclusive between 0 and 2048
Title	The title.	string	String length: inclusive between 0 and 2048
Description	The description.	string	String length: inclusive between 0 and 2048
SearchUrl	The search URL.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "NotSetValue": "sample string 2",
  "AnyValue": "sample string 3",
  "Countries": "sample string 4",
  "Regions": "sample string 5",
  "Locations": "sample string 6",
  "Industries": "sample string 7",
  "Disciplines": "sample string 8",
  "SubDisciplines": "sample string 9",
  "JobType": "sample string 10",
  "PostedSince": "2025-10-27T13:56:44.3342204+00:00",
  "StartDate": "2025-10-27T13:56:44.3342204+00:00",
  "Divisions": "sample string 11",
  "Classifications": "sample string 12",
  "Title": "sample string 13",
  "Description": "sample string 14",
  "SearchUrl": "sample string 15"
}

application/xml, text/xml

Sample:

<SavedSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AnyValue>sample string 3</AnyValue>
  <Classifications>sample string 12</Classifications>
  <Countries>sample string 4</Countries>
  <Description>sample string 14</Description>
  <Disciplines>sample string 8</Disciplines>
  <Divisions>sample string 11</Divisions>
  <Industries>sample string 7</Industries>
  <JobType>sample string 10</JobType>
  <Locations>sample string 6</Locations>
  <Name>sample string 1</Name>
  <NotSetValue>sample string 2</NotSetValue>
  <PostedSince>2025-10-27T13:56:44.3342204+00:00</PostedSince>
  <Regions>sample string 5</Regions>
  <SearchUrl>sample string 15</SearchUrl>
  <StartDate>2025-10-27T13:56:44.3342204+00:00</StartDate>
  <SubDisciplines>sample string 9</SubDisciplines>
  <Title>sample string 13</Title>
</SavedSearch>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created saved search.

SavedSearchViewModel

Name	Description	Type	Additional information
Portal	The portal.	PortalViewModel	None.
User	The user.	UserViewModel	None.
Name	The name.	string	None.
NotSetValue	The not set value.	string	None.
AnyValue	Any value.	string	None.
Countries	The countries.	string	None.
Regions	The regions.	string	None.
Locations	The locations.	string	None.
Industries	The industries.	string	None.
Disciplines	The disciplines.	string	None.
SubDisciplines	The sub disciplines.	string	None.
JobType	The type of the job.	string	None.
PostedSince	The posted since.	date	None.
StartDate	The start date.	date	None.
Divisions	The divisions.	string	None.
Classifications	The classifications.	string	None.
Title	The title.	string	None.
Description	The description.	string	None.
SearchUrl	The search URL.	string	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Portal": {
    "Name": "sample string 1",
    "Uid": "259b8829-54e8-47e5-aa22-81c658f53458",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T13:56:44.349851+00:00",
    "UpdatedBy": "sample string 3"
  },
  "User": {
    "Logon": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "OtherNames": "sample string 4",
    "IsConfirmed": true,
    "CandidateReference": "sample string 6",
    "SecretKey2FA": "sample string 7",
    "Is2FASiteWide": true,
    "Uid": "57e438d1-a8bf-42e1-a17b-b40dcb66460e",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T13:56:44.349851+00:00",
    "UpdatedBy": "sample string 10"
  },
  "Name": "sample string 1",
  "NotSetValue": "sample string 2",
  "AnyValue": "sample string 3",
  "Countries": "sample string 4",
  "Regions": "sample string 5",
  "Locations": "sample string 6",
  "Industries": "sample string 7",
  "Disciplines": "sample string 8",
  "SubDisciplines": "sample string 9",
  "JobType": "sample string 10",
  "PostedSince": "2025-10-27T13:56:44.349851+00:00",
  "StartDate": "2025-10-27T13:56:44.349851+00:00",
  "Divisions": "sample string 11",
  "Classifications": "sample string 12",
  "Title": "sample string 13",
  "Description": "sample string 14",
  "SearchUrl": "sample string 15",
  "Uid": "821939e0-defa-4ace-90a7-16763f0f2ed6",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T13:56:44.349851+00:00",
  "UpdatedBy": "sample string 17"
}

application/xml, text/xml

Sample:

<SavedSearchViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:56:44.349851+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>821939e0-defa-4ace-90a7-16763f0f2ed6</Uid>
  <UpdatedBy>sample string 17</UpdatedBy>
  <AnyValue>sample string 3</AnyValue>
  <Classifications>sample string 12</Classifications>
  <Countries>sample string 4</Countries>
  <Description>sample string 14</Description>
  <Disciplines>sample string 8</Disciplines>
  <Divisions>sample string 11</Divisions>
  <Industries>sample string 7</Industries>
  <JobType>sample string 10</JobType>
  <Locations>sample string 6</Locations>
  <Name>sample string 1</Name>
  <NotSetValue>sample string 2</NotSetValue>
  <Portal>
    <DateUpdated>2025-10-27T13:56:44.349851+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>259b8829-54e8-47e5-aa22-81c658f53458</Uid>
    <UpdatedBy>sample string 3</UpdatedBy>
    <Name>sample string 1</Name>
  </Portal>
  <PostedSince>2025-10-27T13:56:44.349851+00:00</PostedSince>
  <Regions>sample string 5</Regions>
  <SearchUrl>sample string 15</SearchUrl>
  <StartDate>2025-10-27T13:56:44.349851+00:00</StartDate>
  <SubDisciplines>sample string 9</SubDisciplines>
  <Title>sample string 13</Title>
  <User>
    <DateUpdated>2025-10-27T13:56:44.349851+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>57e438d1-a8bf-42e1-a17b-b40dcb66460e</Uid>
    <UpdatedBy>sample string 10</UpdatedBy>
    <CandidateReference>sample string 6</CandidateReference>
    <Forename>sample string 2</Forename>
    <Is2FASiteWide>true</Is2FASiteWide>
    <IsConfirmed>true</IsConfirmed>
    <Logon>sample string 1</Logon>
    <OtherNames>sample string 4</OtherNames>
    <SecretKey2FA>sample string 7</SecretKey2FA>
    <Surname>sample string 3</Surname>
  </User>
</SavedSearchViewModel>