v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Interview Module

Update an interview module

Updates the supplied interview-module configuration, including training requirements, graduation rules, weekly limit, and fast-track setting. Omitted fields are preserved, while supplied approver lists replace the complete list for that graduation step. Null weekly_interview_limit means unlimited.

patch/v1/interview-modules/{moduleId}

Path parameters

moduleIdstring required

an interview module ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Example:mod_a1b2c3d4e5f64789a1b2c3d4e5f64789

Request body

namestring

Module name. Required on create; PATCH replaces it when supplied.

shadows_requiredinteger

Required shadow interviews. Required on create; PATCH replaces it when supplied.

reverse_shadows_requiredinteger

Required reverse-shadow interviews. Required on create; PATCH replaces it when supplied.

graduate_from_shadow_approval_type'AUTOMATIC' | 'SCHEDULER' | 'CUSTOM'

Approval mode for graduating from shadow training. Required on create; PATCH replaces it when supplied.

graduate_from_shadow_custom_approversstring[]

Complete approver-role list for shadow graduation. Required on create; PATCH replaces the list when supplied.

graduate_from_reverse_shadow_approval_type'AUTOMATIC' | 'SCHEDULER' | 'CUSTOM'

Approval mode for graduating from reverse-shadow training. Required on create; PATCH replaces it when supplied.

graduate_from_reverse_shadow_custom_approversstring[]

Complete approver-role list for reverse-shadow graduation. Required on create; PATCH replaces the list when supplied.

weekly_interview_limitinteger nullable

Maximum interviews per week; null means unlimited.

should_fast_track_trainingboolean

Enables fast-track training when true. On PATCH, omission preserves the current value.

Response

Success

idstring required

Canonical interview module ID (mod_ followed by 32 lowercase hexadecimal UUID characters).

namestring required

shadows_requiredinteger required

reverse_shadows_requiredinteger required

graduation_approval'AUTOMATIC' | 'SCHEDULER' | 'CUSTOM' required

weekly_interview_limitinteger nullable required

Maximum interviews per week; null means unlimited.

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

Example response

{
  "id": "mod_a1b2c3d4e5f64789a1b2c3d4e5f64789"
}