POST /v1/interview_plans/{interview_plan_id}/actions/archive

Required scopes: interview_plans:write

post/v1/interview_plans/{interview_plan_id}/actions/archive

Request

Base URL: https://api.yardstick.team
URL: https://api.yardstick.team/v1/interview_plans/{interview_plan_id}/actions/archive
Auth: HTTP bearer

Path parameters

interview_plan_idstring required

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

object required

Response

Plan archived. The response is the plan read shape reflecting the archived state. An already-archived plan succeeds without a write. A plan still attached to a Job is refused with HTTP 409 interview_plan_attached_to_job — detach it from the Job first — including when it is already archived.

object'interview_plan' required

idstring required

lifecycle'published' | 'draft' required

titlestring required

role_namestring nullable required

is_archivedboolean required

draft_status'draft' | 'validated' | 'published' | 'abandoned' nullable required

job_idstring nullable required

versioninteger nullable required

behavioral_anchorsobject required

created_atstring required

updated_atstring required

Changes

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