PATCH
Change, pause or resume the repeating search

Authorizations

x-api-key
string
header
required

An API key from Settings → Developers → API keys in Hiresweep.

Body

application/json
frequency
enum<string>

How often to search: daily or weekly.

Available options:
daily,
weekly
emailDigest
boolean

Whether a run that finds new jobs emails you a digest.

paused
boolean

True to pause the repeating search, false to resume it.

clientId
string | null

The client whose data this is, for an operator applying on behalf of clients. Omit for your own.

Minimum string length: 1

Response

200 - application/json

The repeating search, as changed.

id
string
required

The ID of the repeating search.

clientId
string | null
required

The client it searches for; null for your own.

resumeId
string
required

The resume it searches from.

requestedTargetCount
integer
required

How many Targets the run it was saved from asked for.

Required range: -9007199254740991 <= x <= 9007199254740991
targets
object[]
required

The job titles and ATS keywords it searches for; ticked ones are searched.

filters
object
required

The locations, remote-only, recency and company-stage filters it uses.

frequency
enum<string>
required

How often it searches: daily or weekly.

Available options:
daily,
weekly
nextRunAt
string<date-time>
required

When it next searches, unless it is paused.

pausedAt
string<date-time> | null
required

When it was paused; null while it runs.

emailDigest
boolean
required

Whether a run that finds new jobs emails you a digest of them.

lastRunAt
string<date-time> | null
required

When it last started a search.

lastSkipReason
enum<string> | null
required

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.

Available options:
not_included,
allowance,
daily,
concurrent,
already_searching,
unavailable,
email_unverified,
client_archived,
error
lastSkippedAt
string<date-time> | null
required

When its latest turn was let go by.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
lastRun
object | null
required

The latest search it started; null before its first.