Interview Plan Builder

Validate draft interview plan

Validate draft interview plan

Required scopes: interview_plans:write

Validation is read-only. It returns blockers, warnings, next actions, and the builder web_url deep link when the draft is known, but it does not create write audit/event rows.

Example (curl):

curl -X POST https://api.yardstick.team/v1/interview_plan_drafts/actions/validate_draft \
  -H 'Authorization: Bearer ys_sk_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"interview_plan.validate_draft","resource":{"type":"interview_plan_draft","id":"ipd_…"},"input":{"include_warnings":true}}'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/interview_plan_drafts/actions/validate_draft", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.YS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    action: "interview_plan.validate_draft",
    resource: { type: "interview_plan_draft", id: "ipd_…" },
    input: { include_warnings: true },
  }),
});
post/v1/interview_plan_drafts/actions/validate_draft

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/interview_plan_drafts/actions/validate_draft
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

action'interview_plan.validate_draft' required

Response

Success

action'interview_plan.generate_outcomes' | 'interview_plan.confirm_outcomes' | 'interview_plan.generate_competencies' | 'interview_plan.generate_skills' | 'interview_plan.generate_rounds' | 'interview_plan.add_rounds' | 'interview_plan.update_rounds' | 'interview_plan.delete_rounds' | 'interview_plan.generate_anchors' | 'interview_plan.generate_questions_directions' | 'interview_plan.add_competencies' | 'interview_plan.update_competencies' | 'interview_plan.delete_competencies' | 'interview_plan.add_skills' | 'interview_plan.update_skills' | 'interview_plan.delete_skills' | 'interview_plan.clear_outcomes' | 'interview_plan.clear_competencies' | 'interview_plan.clear_job_skills' | 'interview_plan.clear_interview_sequence' | 'interview_plan.validate_draft' | 'interview_plan.publish' | 'interview_plan.modify_active' | 'interview_plan.add_questions' | 'interview_plan.update_questions' | 'interview_plan.delete_questions' | 'interview_plan.update_round_directions' | 'interview_plan.update_anchors' | 'interview_plan.delete_anchors' required
execution_mode'draft_write' | 'interactive_gate' | 'validate_only' | 'approval_required' | 'blocked_until_verified' required
stagestring required
next_actionsstring[] required
web_urlstring nullable required
request_idstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.