> ## Documentation Index
> Fetch the complete documentation index at: https://docs.talentunveiled.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update organization interview defaults

> Read or partially update your organization's interview defaults.

These fields act as defaults for every job posting in the organization. When a job's own interview configuration leaves a field blank (for example `prompt_intro`), the interview runtime uses the value from this endpoint. Clearing a field here reverts every job that has not set its own override to the platform default.

PATCH is a partial update. Omit a field to leave it unchanged, or send an empty string to clear it. This resource is a singleton per organization: PUT, POST, and DELETE are not supported.

Fields:
- `prompt_intro`: opening script the voice assistant reads at the start of an interview.
- `prompt_outro`: closing script the voice assistant reads at the end of an interview.
- `prompt_additional_instructions`: free-form behavior guidance for the voice assistant, such as tone, off-limit topics, or style. Applied in addition to per-job instructions.
- `interviewer_name_override`: name the voice assistant introduces itself with. Blank falls back to the platform default.
- `organization_name_override`: name the voice assistant uses to refer to your organization during the call. Blank falls back to your organization's display name.
- `cv_context_mode`: how much of the candidate's CV the interview agent receives: `summary`, `disabled`, or `full`.
- `require_recording_consent`: when true, the interviewer asks the candidate to agree to the call being recorded before the interview starts, and ends the call if they decline.



## OpenAPI

````yaml /swagger/v2_schema.yaml patch /organization/interview-defaults
openapi: 3.0.3
info:
  title: TalentUnveiled API v2
  version: 2.0.0
  description: >-
    Public API v2 for managing jobs, applications, interviews, and webhooks.


    **Pagination:** list endpoints return a `{count, next, previous, results}`
    envelope. Page with the `limit` and `offset` query parameters; `limit`
    defaults to 50 and is capped at 200.
servers:
  - url: https://api.talentunveiled.com/api/v2
    description: Production server
security: []
tags:
  - name: Meta
    description: Identify the organization an API key belongs to.
  - name: Jobs
    description: Create, read, update, and archive job postings.
  - name: Applications
    description: Create applications and track them through the pipeline.
  - name: Interview Configuration
    description: The interview config and call schedule for a job.
  - name: Interview Criteria
    description: Evaluation criteria for a job's interview.
  - name: Interview Questions
    description: Questions asked during a job's interview.
  - name: Interview Results
    description: The scored interview result for an application.
  - name: Interview Calls
    description: Call attempts, scheduling, and transcripts.
  - name: CV Evaluations
    description: AI scoring of a candidate's CV against the job.
  - name: Insights
    description: Combined CV and interview insights for an application.
  - name: Webhooks
    description: Manage webhook subscriptions and inspect deliveries.
  - name: Hiring Team
    description: Manage the hiring team assigned to a job posting.
  - name: Members
    description: List the members of the organization.
paths:
  /organization/interview-defaults:
    patch:
      tags:
        - Organization Configuration
      summary: Update organization interview defaults
      description: >-
        Read or partially update your organization's interview defaults.


        These fields act as defaults for every job posting in the organization.
        When a job's own interview configuration leaves a field blank (for
        example `prompt_intro`), the interview runtime uses the value from this
        endpoint. Clearing a field here reverts every job that has not set its
        own override to the platform default.


        PATCH is a partial update. Omit a field to leave it unchanged, or send
        an empty string to clear it. This resource is a singleton per
        organization: PUT, POST, and DELETE are not supported.


        Fields:

        - `prompt_intro`: opening script the voice assistant reads at the start
        of an interview.

        - `prompt_outro`: closing script the voice assistant reads at the end of
        an interview.

        - `prompt_additional_instructions`: free-form behavior guidance for the
        voice assistant, such as tone, off-limit topics, or style. Applied in
        addition to per-job instructions.

        - `interviewer_name_override`: name the voice assistant introduces
        itself with. Blank falls back to the platform default.

        - `organization_name_override`: name the voice assistant uses to refer
        to your organization during the call. Blank falls back to your
        organization's display name.

        - `cv_context_mode`: how much of the candidate's CV the interview agent
        receives: `summary`, `disabled`, or `full`.

        - `require_recording_consent`: when true, the interviewer asks the
        candidate to agree to the call being recorded before the interview
        starts, and ends the call if they decline.
      operationId: organization_interview_defaults_partial_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationInterviewDefaultsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationInterviewDefaults'
          description: ''
        '400':
          description: Invalid input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    PatchedOrganizationInterviewDefaultsRequest:
      type: object
      properties:
        prompt_intro:
          type: string
          description: Default intro script for new interviews in this organization.
        prompt_outro:
          type: string
          description: Default outro script for new interviews in this organization.
        prompt_additional_instructions:
          type: string
          description: >-
            Default additional voice-assistant instructions for new interviews
            in this organization.
        interviewer_name_override:
          type: string
          description: >-
            Org-wide interviewer name for interviews. Blank falls back to the
            system default name.
          maxLength: 100
        organization_name_override:
          type: string
          description: >-
            Org-wide organization name spoken in interviews. Blank falls back to
            the organization's name.
          maxLength: 100
        cv_context_mode:
          allOf:
            - $ref: '#/components/schemas/CVContextModeEnum'
          description: >-
            How much of the candidate's CV the interview agent receives. SUMMARY
            gives the latest role and top skills only. DISABLED omits the CV
            entirely. FULL gives the complete dated work and education history
            AND lets the agent raise up to two topics drawn from it, so it may
            ask about a career change or an unexplained employment gap. Choose
            FULL only if that questioning is wanted, not merely to give the
            agent more context.


            * `disabled` - Disabled (No CV context)

            * `summary` - Summary (Key highlights only)

            * `full` - Full (Complete CV markdown)
        require_recording_consent:
          type: boolean
          description: >-
            When enabled, the interviewer asks the candidate to agree to the
            call being recorded before the interview starts, and ends the call
            if they decline. When disabled, no consent question is asked.
        default_interview_mode:
          allOf:
            - $ref: '#/components/schemas/InterviewModeEnum'
          description: >-
            Interview mode applied to new job postings that do not specify one.
            WEB runs the interview in the browser, PHONE calls the candidate.


            * `web` - Web

            * `phone` - Phone
        generation_additional_instructions:
          type: string
          description: >-
            Extra instructions passed to criteria and question generation for
            every job in this organization, for example to ask for a short
            screening rather than a full interview. Blank means no extra
            steering.
    OrganizationInterviewDefaults:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        prompt_intro:
          type: string
          description: Default intro script for new interviews in this organization.
        prompt_outro:
          type: string
          description: Default outro script for new interviews in this organization.
        prompt_additional_instructions:
          type: string
          description: >-
            Default additional voice-assistant instructions for new interviews
            in this organization.
        interviewer_name_override:
          type: string
          description: >-
            Org-wide interviewer name for interviews. Blank falls back to the
            system default name.
          maxLength: 100
        organization_name_override:
          type: string
          description: >-
            Org-wide organization name spoken in interviews. Blank falls back to
            the organization's name.
          maxLength: 100
        cv_context_mode:
          allOf:
            - $ref: '#/components/schemas/CVContextModeEnum'
          description: >-
            How much of the candidate's CV the interview agent receives. SUMMARY
            gives the latest role and top skills only. DISABLED omits the CV
            entirely. FULL gives the complete dated work and education history
            AND lets the agent raise up to two topics drawn from it, so it may
            ask about a career change or an unexplained employment gap. Choose
            FULL only if that questioning is wanted, not merely to give the
            agent more context.


            * `disabled` - Disabled (No CV context)

            * `summary` - Summary (Key highlights only)

            * `full` - Full (Complete CV markdown)
        require_recording_consent:
          type: boolean
          description: >-
            When enabled, the interviewer asks the candidate to agree to the
            call being recorded before the interview starts, and ends the call
            if they decline. When disabled, no consent question is asked.
        default_interview_mode:
          allOf:
            - $ref: '#/components/schemas/InterviewModeEnum'
          description: >-
            Interview mode applied to new job postings that do not specify one.
            WEB runs the interview in the browser, PHONE calls the candidate.


            * `web` - Web

            * `phone` - Phone
        generation_additional_instructions:
          type: string
          description: >-
            Extra instructions passed to criteria and question generation for
            every job in this organization, for example to ask for a short
            screening rather than a full interview. Blank means no extra
            steering.
      required:
        - created_at
        - id
        - updated_at
    ErrorResponse:
      type: array
      description: List of errors
      items:
        $ref: '#/components/schemas/ErrorItem'
    CVContextModeEnum:
      enum:
        - disabled
        - summary
        - full
      type: string
      description: |-
        * `disabled` - Disabled (No CV context)
        * `summary` - Summary (Key highlights only)
        * `full` - Full (Complete CV markdown)
    InterviewModeEnum:
      enum:
        - web
        - phone
      type: string
      description: |-
        * `web` - Web
        * `phone` - Phone
    ErrorItem:
      type: object
      description: Individual error item
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCodeEnum'
          description: Machine-readable error code
        detail:
          type: string
          description: Human-readable error message
        attr:
          type: string
          nullable: true
          description: Field name this error relates to (for validation errors)
      required:
        - code
        - detail
    ErrorCodeEnum:
      type: string
      enum:
        - error
        - invalid_input
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - throttled
        - required
        - does_not_exist
        - incorrect_type
        - no_match
        - incorrect_match
        - not_a_list
        - not_a_dict
        - empty
        - candidate_user_mismatch
        - candidate_not_found
        - cross_organization_application
        - already_exists
        - call_service_error
        - call_not_joinable
        - call_config_error
        - call_access_denied
        - call_already_linked
        - date_range_too_large
        - date_range_start_after_end
        - invalid_date
        - language_not_configured
        - vapi_api_error
        - webhook_processing_error
        - proxy_error
        - configuration_error
        - interview_call_already_processed
        - call_type_switch_error
        - slot_in_past
        - interview_not_scheduled
        - interview_opt_out_not_eligible
        - interview_retry_not_allowed
        - retake_limit_reached
        - interview_session_not_joinable
        - interview_session_retake_not_eligible
        - interview_session_already_processing
        - interview_session_not_completed
        - interview_session_reset_not_allowed
        - interview_mode_locked
        - application_already_exists
        - gateway_verification_failed
        - invalid_file_type
        - file_too_large
        - cv_already_exists
        - cv_required
        - custom_fields_too_large
        - nylas_grant_already_exists
        - nylas_upstream_error
        - otp_challenge_not_found
        - job_posting_not_found
        - job_application_not_found
        - workflow_execution_error
        - llm_generation_failed
        - report_generation_failed
        - interview_config_has_no_criteria
        - scheduling_not_enabled
        - interview_session_not_reschedulable
        - interview_version_mismatch
        - v3_job_missing_config
        - idempotency_key_conflict
        - idempotency_key_invalid
        - application_status_transition_invalid
        - application_state_conflict
        - external_id_conflict
        - qualification_cannot_have_score
        - competency_requires_bars
      description: Machine-readable error code
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        API key authentication for the public API. Pass your API key as a Bearer
        token.

````