Sign in

v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
Interview Module

Create an interview module

Creates an interview module with its shadow and reverse-shadow requirements, graduation rules, and weekly interview limit. The create body supplies the complete training configuration; null weekly_interview_limit means unlimited. The response includes the new module and its initial member counts.

post/v1/interview-modules

Request body

namestring required

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

shadows_requiredinteger required

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

reverse_shadows_requiredinteger required

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

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

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

graduate_from_shadow_custom_approversstring[] required

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

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

graduate_from_reverse_shadow_custom_approversstring[] required

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

weekly_interview_limitinteger nullable required

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"
}