v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Interview Module

Add a member to an interview module

Adds one employee as a member of an interview module with optional initial training status and per-member requirements. When supplied, the member weekly-limit override uses null to mean unlimited. The response returns the new membership and calculated training progress.

post/v1/interview-modules/{moduleId}/members

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

employee_idstring required

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

training_status'TRAINED' | 'SHADOW' | 'REVERSE_SHADOW'

shadows_requiredinteger

reverse_shadows_requiredinteger

weekly_interview_limit_overrideinteger nullable

Maximum interviews per week; null means unlimited.

Example request

{
  "employee_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
}

Response

Success

training_status'TRAINED' | 'SHADOW' | 'REVERSE_SHADOW' required

next_status'TRAINED' | 'SHADOW' | 'REVERSE_SHADOW' required

shadow_started_atstring date-time nullable required

ISO 8601 timestamp.

reverse_shadow_started_atstring date-time nullable required

ISO 8601 timestamp.

trained_atstring date-time nullable required

ISO 8601 timestamp.

time_to_traininteger required

weekly_interview_limit_overrideinteger nullable required

Member-specific maximum interviews per week; null means unlimited.

progress_percentageinteger required

Example response

{
  "employee": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  }
}