v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB

Interviewers

Update an interviewer

Update fields on an existing interviewer. Only provided fields are modified; omitted fields remain unchanged.

patch/api/v2/postings/{posting_id}

Path parameters

posting_idstring required

Headers

X-API-KEYstring nullable

Authorizationstring nullable

X-Workspace-Idstring nullable

Request body

titlestring nullable

Updated job title.

descriptionstring nullable

Updated job description.

namestring nullable

Updated URL slug.

languagestring nullable

Updated default language (BCP-47).

interviewer_namestring nullable

Updated AI interviewer display name.

instructionsstring nullable

Updated global instructions for the AI interviewer.

company_overviewstring nullable

Updated company overview.

job_overviewstring nullable

Updated job overview.

interview_process_overviewstring nullable

Updated process overview shared with agents.

company_overview_delivery_mode'exact_delivery' | 'summarized_delivery' | 'reference_only' | 'silent_reference' nullable

Updated company overview delivery mode.

job_overview_delivery_mode'exact_delivery' | 'summarized_delivery' | 'reference_only' | 'silent_reference' nullable

Updated job overview delivery mode.

interview_process_overview_delivery_mode'exact_delivery' | 'summarized_delivery' | 'reference_only' | 'silent_reference' nullable

Updated interview process overview delivery mode.

phone_number_idstring nullable

Updated phone number ID.

sender_email_idstring nullable

Updated sender email ID.

email_template_group_idstring nullable

Updated email template group ID.

design_template_group_idstring nullable

Updated design template group ID.

redirect_urlstring nullable

Updated post-completion redirect URL.

scheduling_urlstring nullable

Updated scheduling URL for shortlisted candidates.

deadlinestring nullable

Updated ISO 8601 deadline.

allow_sms_commsboolean nullable

Updated SMS communications flag.

max_retakesinteger nullable

Updated max retake attempts (0-5).

retake_cooldown_daysnumber nullable

Updated retake cooldown in days.

email_report_to_candidateboolean nullable

Updated email report flag.

metadataobject nullable

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

Example request

{
  "metadata": {
    "external_id": "ats_12345",
    "source": "workday"
  }
}

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

Example response

{
  "data": {
    "id": "13D77095",
    "company_id": "comp_abc123",
    "title": "Senior Software Engineer",
    "name": "senior-software-engineer",
    "description": "We are looking for a senior software engineer...",
    "language": "en",
    "interviewer_name": "Sarah",
    "status": "active",
    "finalized": true,
    "workflow": [
      {
        "id": "agent_vi_001",
        "type": "web_interview",
        "order": 1
      }
    ],
    "urls": {
      "candidate_url": "https://candidates.heymilo.io/acme/senior-engineer",
      "ingestion_url_key": "ibURejyPMSlw6de0OZUdoxyoXTgWO78ey2NUo96EOG1gY",
      "review_url": "https://admin.heymilo.ai/w/ABC123/lab2/POST_ID/1-details"
    },
    "deadline": 1775174400,
    "redirect_url": "https://acme.com/thank-you",
    "scheduling_url": "https://cal.com/acme/interview",
    "max_retakes": 1,
    "ats_metadata": {
      "ats_job_id": "WK-12345",
      "ats_name": "workable",
      "pending_activation": true,
      "source": "job_sync"
    },
    "metadata": {
      "external_id": "ats_12345",
      "source": "workday"
    },
    "created_at": 1739612400,
    "updated_at": 1739617200
  }
}