Interview Plan Builder

Publish an interview plan (preview→bind)

Publish an interview plan (preview→bind)

Required scopes: interview_plans:write, interview_plans:publish

Preview→bind flow. Calling without a binding returns HTTP 202 with the approval-required envelope (no mutation); the 200 response shape documented here is returned only on the bind call, which persists a new interview_plans row. To execute, re-issue with binding echoing the preview's preview_hash, approved_action_key, approved_input_hash, approved_idempotency_key, and resource_version_precondition. The key captured in approval.binding.approved_idempotency_key must match on the bind request.

Example (curl):

curl -X POST https://api.yardstick.team/v1/interview_plans/actions/publish \
  -H 'Authorization: Bearer ys_sk_live_…' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 7c3a…' \
  -d '{"action":"interview_plan.publish","input":{"draft_id":"ipd_…"}}'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/interview_plans/actions/publish", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.YS_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    action: "interview_plan.publish",
    input: { draft_id: "ipd_…" },
  }),
});
post/v1/interview_plans/actions/publish

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/interview_plans/actions/publish
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Required for this operation. Reuse the same key to safely retry the same request.

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.publish' required

Response

Success

object'interview_plan' required
idstring required
titlestring required
role_namestring required
additional_infostring nullable required
outcomesunknown
competenciesunknown
job_skillsunknown
interview_sequenceunknown
behavioral_anchorsunknown
is_archivedboolean required
archived_atstring nullable required
archived_bystring nullable required
archived_reasonstring nullable required
group_idstring nullable required
created_bystring nullable required
current_stepinteger nullable required
visited_stepsunknown
completed_stepsunknown
versioninteger required
locationstring nullable required
location_typestring nullable required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.