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

Activate an interviewer

cURL

curl --request POST \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/activate \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "company_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "status": "<string>",
    "finalized": true,
    "archived": true,
    "test_posting": true,
    "object": "posting",
    "name": "senior-software-engineer",
    "language": "en",
    "interviewer_name": "Sarah",
    "workflow": [
      {
        "type": "<string>",
        "order": 123,
        "id": "agent_vi_001",
        "config": {}
      }
    ],
    "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,
    "allow_sms_comms": false,
    "instructions": "<string>",
    "company_overview": "<string>",
    "job_overview": "<string>",
    "interview_process_overview": "<string>",
    "company_overview_delivery_mode": "<string>",
    "job_overview_delivery_mode": "<string>",
    "interview_process_overview_delivery_mode": "<string>",
    "phone_number_id": "<string>",
    "sender_email_id": "<string>",
    "email_template_group_id": "<string>",
    "design_template_group_id": "<string>",
    "retake_cooldown_days": 123,
    "email_report_to_candidate": false,
    "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
  },
  "meta": {}
}

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

Response

200

application/json

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.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.