POST
Start a new draft from an earlier Discovery run

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

The ID of the Discovery run to copy.

Minimum string length: 1

Body

application/json
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 new drafting run.

id
string
required

The ID of the Discovery run.

clientId
string | null
required

The client this run is for; null for your own.

resumeId
string | null
required

The resume the run searches from; null once that resume is deleted.

requestedTargetCount
integer
required

How many Targets the recruiter prompt was asked for.

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

The job titles and ATS keywords, as the user edited them; ticked ones are searched.

targetsGeneratingSince
string<date-time> | null
required

When the recruiter prompt started writing this draft's Targets, which arrive one by one; null once it has finished or failed. A draft cannot be edited or searched while it is set.

filters
object
required

The locations, remote-only, recency and company-stage filters this run searches under.

status
enum<string>
required

Drafting, searching, done, failed, or cancelled.

Available options:
drafting,
searching,
done,
failed,
cancelled
statusChangedAt
string<date-time>
required
failureReason
string | null
required

Why the run stopped, if it did: generating Targets while drafting, or the search once it failed.

boardOutcomes
object[]
required

What each board's search came to: it ran, the board blocked it, or it was cut short.

events
object[]
required

What the search did, line by line, latest last.

lastProgressAt
string<date-time> | null
required

The latest sign of life from the search.

scheduleId
string | null
required

The repeating search that started this run, while it exists; null for a run started by hand.

scheduled
boolean
required

Whether a repeating search started this run, rather than you.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required