curl --request PATCH \
--url https://hiresweep.com/api/openapi/discovery/schedule \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"emailDigest": true,
"paused": true,
"clientId": "<string>"
}
'import requests
url = "https://hiresweep.com/api/openapi/discovery/schedule"
payload = {
"emailDigest": True,
"paused": True,
"clientId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({emailDigest: true, paused: true, clientId: '<string>'})
};
fetch('https://hiresweep.com/api/openapi/discovery/schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hiresweep.com/api/openapi/discovery/schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'emailDigest' => true,
'paused' => true,
'clientId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hiresweep.com/api/openapi/discovery/schedule"
payload := strings.NewReader("{\n \"emailDigest\": true,\n \"paused\": true,\n \"clientId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://hiresweep.com/api/openapi/discovery/schedule")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"emailDigest\": true,\n \"paused\": true,\n \"clientId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/discovery/schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailDigest\": true,\n \"paused\": true,\n \"clientId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"clientId": "<string>",
"resumeId": "<string>",
"requestedTargetCount": 0,
"targets": [
{
"title": "<string>",
"keywords": [
"<string>"
],
"selected": true
}
],
"filters": {
"locations": [
"<string>"
],
"remoteOnly": true,
"postedWithinDays": 1,
"companyStages": [
"early"
]
},
"frequency": "daily",
"nextRunAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-11-07T05:31:56Z",
"emailDigest": true,
"lastRunAt": "2023-11-07T05:31:56Z",
"lastSkipReason": "not_included",
"lastSkippedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastRun": {
"id": "<string>",
"status": "drafting",
"createdAt": "2023-11-07T05:31:56Z",
"newMatchCount": 0
}
}Change, pause or resume the repeating search
Changes how often the workspace’s repeating search runs, whether it emails new jobs, or pauses and resumes it. A paused search does not run until resumed; resuming keeps its time of day. Requires authentication.
curl --request PATCH \
--url https://hiresweep.com/api/openapi/discovery/schedule \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"emailDigest": true,
"paused": true,
"clientId": "<string>"
}
'import requests
url = "https://hiresweep.com/api/openapi/discovery/schedule"
payload = {
"emailDigest": True,
"paused": True,
"clientId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({emailDigest: true, paused: true, clientId: '<string>'})
};
fetch('https://hiresweep.com/api/openapi/discovery/schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hiresweep.com/api/openapi/discovery/schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'emailDigest' => true,
'paused' => true,
'clientId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hiresweep.com/api/openapi/discovery/schedule"
payload := strings.NewReader("{\n \"emailDigest\": true,\n \"paused\": true,\n \"clientId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://hiresweep.com/api/openapi/discovery/schedule")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"emailDigest\": true,\n \"paused\": true,\n \"clientId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/discovery/schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailDigest\": true,\n \"paused\": true,\n \"clientId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"clientId": "<string>",
"resumeId": "<string>",
"requestedTargetCount": 0,
"targets": [
{
"title": "<string>",
"keywords": [
"<string>"
],
"selected": true
}
],
"filters": {
"locations": [
"<string>"
],
"remoteOnly": true,
"postedWithinDays": 1,
"companyStages": [
"early"
]
},
"frequency": "daily",
"nextRunAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-11-07T05:31:56Z",
"emailDigest": true,
"lastRunAt": "2023-11-07T05:31:56Z",
"lastSkipReason": "not_included",
"lastSkippedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastRun": {
"id": "<string>",
"status": "drafting",
"createdAt": "2023-11-07T05:31:56Z",
"newMatchCount": 0
}
}Authorizations
An API key from Settings → Developers → API keys in Hiresweep.
Body
How often to search: daily or weekly.
daily, weekly Whether a run that finds new jobs emails you a digest.
True to pause the repeating search, false to resume it.
The client whose data this is, for an operator applying on behalf of clients. Omit for your own.
1Response
The repeating search, as changed.
The ID of the repeating search.
The client it searches for; null for your own.
The resume it searches from.
How many Targets the run it was saved from asked for.
-9007199254740991 <= x <= 9007199254740991The job titles and ATS keywords it searches for; ticked ones are searched.
Show child attributes
Show child attributes
The locations, remote-only, recency and company-stage filters it uses.
Show child attributes
Show child attributes
How often it searches: daily or weekly.
daily, weekly When it next searches, unless it is paused.
When it was paused; null while it runs.
Whether a run that finds new jobs emails you a digest of them.
When it last started a search.
Why its latest turn was let go by without a search (the plan's limit, a search already running, and so on); null when its latest turn searched.
not_included, allowance, daily, concurrent, already_searching, unavailable, email_unverified, client_archived, error When its latest turn was let go by.
The latest search it started; null before its first.
Show child attributes
Show child attributes