v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Interview Module

Update an interview module member

Partially updates a member's training requirements, status, pause state, timestamps, and weekly limit. Changes to required counts can advance training through the module's configured approval rules; setting training_status to TRAINED marks the member trained directly.

patch/v1/interview-modules/{moduleId}/members/{memberId}

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

memberIdstring 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.

Example:emp_a1b2c3d4e5f64789a1b2c3d4e5f64789

Request body

training_status'TRAINED'

Administratively marks the member TRAINED. Earlier training phases can only change through the module's count-driven and approval-gated graduation rules.

paused_untilstring date-time

Pauses the member until this timestamp. Cannot be combined with another pause field.

pause_indefinitelytrue

Pauses the member indefinitely. Cannot be combined with another pause field.

clear_pausetrue

Clears the member's pause. Cannot be combined with another pause field.

shadows_requiredinteger

Sets the member-specific required shadow interview count from 0 through 20.

reverse_shadows_requiredinteger

Sets the member-specific required reverse-shadow interview count from 0 through 20.

shadow_or_reverse_shadow_increment_byinteger

Adjusts the required count for the member's current SHADOW or REVERSE_SHADOW phase. May be negative.

weekly_interview_limit_overrideinteger nullable

Sets the member-specific weekly interview limit override from 1 through 10; null means unlimited.

trained_atstring date-time

Sets the member's trained timestamp. Cannot be combined with clear_trained_at.

clear_trained_attrue

Clears the member's trained timestamp. Cannot be combined with trained_at.

added_to_module_atstring date-time

Overrides the timestamp when the interviewer was added to the module.

Example request

{
  "shadows_required": 2,
  "reverse_shadows_required": 1,
  "weekly_interview_limit_override": 4
}

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