Skip to main content
PATCH
Update an interviewer

Authorizations

X-API-KEY
string
header
required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY
string | null
Authorization
string | null
X-Workspace-Id
string | null

Path Parameters

posting_id
string
required

Body

application/json

Request body for updating a posting. All fields are optional.

title
string | null

Updated job title.

Required string length: 3 - 200
description
string | null

Updated job description.

Required string length: 10 - 50000
name
string | null

Updated URL slug.

Maximum string length: 100
language
string | null

Updated default language (BCP-47).

interviewer_name
string | null

Updated AI interviewer display name.

Maximum string length: 100
instructions
string | null

Updated global instructions for the AI interviewer.

Maximum string length: 10000
company_overview
string | null

Updated company overview.

Maximum string length: 10000
job_overview
string | null

Updated job overview.

Maximum string length: 10000
interview_process_overview
string | null

Updated process overview shared with agents.

Maximum string length: 10000
company_overview_delivery_mode
enum<string> | null

Updated company overview delivery mode.

Available options:
exact_delivery,
summarized_delivery,
reference_only,
silent_reference
job_overview_delivery_mode
enum<string> | null

Updated job overview delivery mode.

Available options:
exact_delivery,
summarized_delivery,
reference_only,
silent_reference
interview_process_overview_delivery_mode
enum<string> | null

Updated interview process overview delivery mode.

Available options:
exact_delivery,
summarized_delivery,
reference_only,
silent_reference
phone_number_id
string | null

Updated phone number ID.

sender_email_id
string | null

Updated sender email ID.

email_template_group_id
string | null

Updated email template group ID.

design_template_group_id
string | null

Updated design template group ID.

redirect_url
string | null

Updated post-completion redirect URL.

scheduling_url
string | null

Updated scheduling URL for shortlisted candidates.

deadline
string | null

Updated ISO 8601 deadline.

allow_sms_comms
boolean | null

Updated SMS communications flag.

max_retakes
integer | null

Updated max retake attempts (0-5).

Required range: 0 <= x <= 5
retake_cooldown_days
number | null

Updated retake cooldown in days.

Required range: x >= 0
email_report_to_candidate
boolean | null

Updated email report flag.

metadata
Metadata · object | null

Updated key-value metadata. Replaces existing metadata entirely. Up to 50 keys, each key max 40 chars, each value max 500 chars.

Example:

Response

Successful Response

data
PostingResponse · object
required

A job posting with its full agentic workflow configuration.

A posting represents a complete hiring pipeline — it defines the job, the AI agents involved, and how candidates progress through each screening step.

meta
Meta · object | null

Optional metadata. Shape varies by endpoint.