Skip to content

Update Hiring Keyword

PATCH
/intent/keywords/{keyword_id}

Edit a HIRING listener in place: its name, filters or watchlist scope.

Only jobs and job_changes listeners are editable here; any other keyword is a 404. search_filters is a FULL REPLACEMENT.

Authorizations

Parameters

Path Parameters

keyword_id
required

The keyword’s id.

string format: uuid

The keyword’s id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Partial update of a HIRING listener (jobs / job_changes keyword).

Omitted fields are left alone. The app refuses a plain intent keyword here with a 404; its filters are replaced with POST /intent/keywords/{id}/filters.

object
keyword
Any of:
string
search_filters
Any of:
object
key
additional properties
any
watchlist_source
Any of:
string

Responses

200

Successful Response

object
data
required

One intent object or handler response.

Open-shaped: these payloads carry corpus detail that grows with the corpus. A list result is returned under items.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string