Skip to main content
PATCH
Update an interview module
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"

Body

application/json
name
string

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

Minimum string length: 1
shadows_required
integer

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

Required range: 0 <= x <= 20
reverse_shadows_required
integer

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

Required range: 0 <= x <= 20
graduate_from_shadow_approval_type
enum<string>

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

Available options:
AUTOMATIC,
SCHEDULER,
CUSTOM
graduate_from_shadow_custom_approvers
enum<string>[]

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

Available options:
TRAINED,
TRAINEE,
SCHEDULER
graduate_from_reverse_shadow_approval_type
enum<string>

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

Available options:
AUTOMATIC,
SCHEDULER,
CUSTOM
graduate_from_reverse_shadow_custom_approvers
enum<string>[]

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

Available options:
TRAINED,
TRAINEE,
SCHEDULER
weekly_interview_limit
integer | null

Maximum interviews per week; null means unlimited.

Required range: 1 <= x <= 10
should_fast_track_training
boolean

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

Response

Success

id
string
required

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

Pattern: ^mod_[0-9a-f]{32}$
Example:

"mod_a1b2c3d4e5f64789a1b2c3d4e5f64789"

name
string
required
shadows_required
integer
required
reverse_shadows_required
integer
required
graduation_approval
enum<string>
required
Available options:
AUTOMATIC,
SCHEDULER,
CUSTOM
weekly_interview_limit
integer | null
required

Maximum interviews per week; null means unlimited.

member_counts
object
required
created_at
string<date-time>
required

ISO 8601 timestamp.

updated_at
string<date-time>
required

ISO 8601 timestamp.