Update or reorder one draft round's questions verbatim
Update or reorder one draft round's questions verbatim
Required scopes: interview_plans:write
Replaces questions by id within one round and/or reorders them. order must be a complete permutation of that round's resulting question ids; pure reorder works with order alone.
Question ids. Generated questions are stored without ids; the first edit touching a round's questions persists derived question_N ids for every question in that round in the same write. Read the draft first to discover the ids.
Verbatim edit. The draft stores exactly what you send — no AI generation, no rewriting; the same request always produces the same stored content. The response echoes the stored stage content plus the full stage_versions map.
Fetch-modify-submit with source_stage. Read the draft with GET /v1/interview_plan_drafts/{draft_id}, take the edited stage's version from stage_versions, and pass it as source_stage: {stage, version}. If the stage changed since your read, the edit returns 409 stale_source_stage instead of overwriting it. Editing a stage whose prerequisite checkpoint is missing returns 409 stage_prerequisite_missing.
Atomic write. Every mutated stage's version bumps in one write, and a validated draft rolls back to draft so validation reflects the new content.
Item ids. Unknown item ids return 404 draft_item_not_found naming the id. Caller-supplied ids that duplicate an existing id, or repeat within one request, are rejected naming the id; omitted ids on add_* are minted server-side and never collide with existing ids.
Writes return data.audit with audit/event ids. Successful write events and audit rows include the resource type, public draft id, action key, request context, livemode partition, and a redacted payload summary. Use Idempotency-Key on retries; replayed requests return the cached response and do not duplicate draft checkpoints, audit rows, or events.
Example (curl):
curl -X POST https://api.yardstick.team/v1/interview_plan_drafts/actions/update_questions \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-d '{"action":"interview_plan.update_questions","resource":{"type":"interview_plan_draft","id":"ipd_…"},"input":{"round_id":"round_1","questions":[{"id":"question_2","text":"Tell me about a deal you lost and what you changed after."}],"source_stage":{"stage":"questions_and_directions","version":5}}}'
Example (TypeScript):
await fetch("https://api.yardstick.team/v1/interview_plan_drafts/actions/update_questions", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"action": "interview_plan.update_questions",
"resource": {
"type": "interview_plan_draft",
"id": "ipd_…"
},
"input": {
"round_id": "round_1",
"questions": [
{
"id": "question_2",
"text": "Tell me about a deal you lost and what you changed after."
}
],
"source_stage": {
"stage": "questions_and_directions",
"version": 5
}
}
}),
});
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/interview_plan_drafts/actions/update_questions
- Auth: HTTP bearer
Headers
Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.
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
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.