v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB

Interviewers

Activate an interviewer

Activate an interviewer so it begins accepting candidates. The interviewer must have a valid workflow configuration.

For ATS-derived postings still in the pending_activation intermediate stage (created via createPosting with an ATS-derived interview_template_id, or clonePosting of an ATS-derived posting), this call finalizes the posting and attaches the ATS mapping so candidate ingestion from the ATS begins. The two steps run in one call; the ATS attach is idempotent and best-effort, so re-calling activate is safe and a transient ATS integrator hiccup will not block finalize.

post/api/v2/postings/{posting_id}/activate

Path parameters

posting_idstring required

Headers

X-API-KEYstring nullable

Authorizationstring nullable

X-Workspace-Idstring nullable

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
  }
}