Skip to main content
PATCH
Update an interview module member
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

moduleId
string
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.

Pattern: ^(?:mod_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"mod_a1b2c3d4e5f64789a1b2c3d4e5f64789"

memberId
string
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.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Body

application/json

A partial interview-module membership update. Include at least one field. Unknown fields are rejected.

training_status
enum<string>

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

Available options:
TRAINED
Example:

"TRAINED"

paused_until
string<date-time>

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

Example:

"2026-08-01T09:00:00.000Z"

pause_indefinitely
enum<boolean>

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

Available options:
true
Example:

true

clear_pause
enum<boolean>

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

Available options:
true
Example:

true

shadows_required
integer

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

Required range: 0 <= x <= 20
Example:

2

reverse_shadows_required
integer

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

Required range: 0 <= x <= 20
Example:

1

shadow_or_reverse_shadow_increment_by
integer

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

Example:

1

weekly_interview_limit_override
integer | null

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

Required range: 1 <= x <= 10
Example:

4

trained_at
string<date-time>

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

Example:

"2026-07-15T14:30:00.000Z"

clear_trained_at
enum<boolean>

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

Available options:
true
Example:

true

added_to_module_at
string<date-time>

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

Example:

"2026-06-01T12:00:00.000Z"

Response

Success

employee
object
required
training_status
enum<string>
required
Available options:
TRAINED,
SHADOW,
REVERSE_SHADOW
next_status
enum<string>
required
Available options:
TRAINED,
SHADOW,
REVERSE_SHADOW
paused
object
required
shadow_started_at
string<date-time> | null
required

ISO 8601 timestamp.

reverse_shadow_started_at
string<date-time> | null
required

ISO 8601 timestamp.

trained_at
string<date-time> | null
required

ISO 8601 timestamp.

time_to_train
integer
required
Required range: x >= 0
weekly_interview_limit_override
integer | null
required

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

progress_percentage
integer
required
Required range: 0 <= x <= 100
training_progress
object
required