Skip to main content
POST
Create an interview module

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Body

application/json
name
string
required

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

Minimum string length: 1
shadows_required
integer
required

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

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

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

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

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>[]
required

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

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>[]
required

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
required

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. Responses are normalized to UTC with a Z suffix.

updated_at
string<date-time>
required

ISO 8601 timestamp. Responses are normalized to UTC with a Z suffix.

app_url
string<uri>
required

Link that opens this resource in the ModernLoop app.