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

# Update Requestor

> Update this profile, including the default when addressed by ID. Requires requestors:write. Omitted fields remain unchanged; null clears nullable settings; supplied affidavit arrays replace their collections. Updates apply to linked retrievals. The API does not delete profiles, switch the default, or reassign retrievals.



## OpenAPI

````yaml PATCH /v2/requestors/{requestor_id}
openapi: 3.0.1
info:
  title: Tavrn Platform API
  version: 1.0.0
  description: >-
    Enterprise API for medical record retrieval: cases, retrieval requests,
    retrieved records and provider invoices, case documents, and webhook
    notifications.
  contact:
    name: Tavrn Support
    email: contact@tavrn.ai
servers:
  - url: https://enterprise.tavrn.ai
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Cases
    description: Case management operations
  - name: Documents
    description: Document upload and management
  - name: Retrieval Requests
    description: Medical record retrieval requests submitted to healthcare facilities
  - name: Requestors
    description: Multiple retrieval profiles within one organization
  - name: Webhooks
    description: Webhook registration and event notifications
paths:
  /v2/requestors/{requestor_id}:
    patch:
      tags:
        - Requestors
      summary: Update Requestor
      description: >-
        Update this profile, including the default when addressed by ID.
        Requires requestors:write. Omitted fields remain unchanged; null clears
        nullable settings; supplied affidavit arrays replace their collections.
        Updates apply to linked retrievals. The API does not delete profiles,
        switch the default, or reassign retrievals.
      operationId: updateRequestor
      parameters:
        - name: requestor_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: '111111111111111111111111'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestorUpdate'
      responses:
        '200':
          description: Profile updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Requestor'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Requestor not found in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict; retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RequestorUpdate:
      type: object
      properties:
        name:
          type: string
          nullable: true
          minLength: 1
          maxLength: 500
          description: >-
            Name override. Null restores the organization-name fallback;
            omission preserves the name.
        provider_invoice_limit:
          type: number
          minimum: 0
          nullable: true
          description: >-
            Provider invoice approval limit in USD. Null uses $100; 0 prevents
            automatic payment of positive provider costs.
        letter_of_rep:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorUploadReference'
        rfc_form:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorUploadReference'
        affidavits:
          $ref: '#/components/schemas/RequestorAffidavitsInput'
        correspondence:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorCorrespondence'
      minProperties: 1
      additionalProperties: false
      description: >-
        Update supplied fields only. Null clears nullable document
        slots/settings; arrays replace their corresponding collection. Changes
        affect existing linked retrievals.
    Requestor:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: '111111111111111111111111'
        name:
          type: string
          nullable: true
          description: Name override, or null to use the organization name.
        is_default:
          type: boolean
          description: >-
            Whether this profile is selected when creation omits both Requestor
            fields.
        provider_invoice_limit:
          type: number
          minimum: 0
          nullable: true
          description: >-
            Provider invoice approval limit in USD. Null uses $100; 0 prevents
            automatic payment of positive provider costs.
        effective_provider_invoice_limit:
          type: number
          minimum: 0
          description: Applied approval limit in USD after resolving null to $100.
        letter_of_rep:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorFile'
        rfc_form:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorFile'
        affidavits:
          type: object
          required:
            - declared_families
            - documents
            - generic
            - config_revision
          properties:
            declared_families:
              type: array
              items:
                type: string
                enum:
                  - records
                  - billing
                  - radiology
            documents:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/RequestorFile'
                  - type: object
                    properties:
                      family:
                        type: string
                        enum:
                          - records
                          - billing
                          - radiology
                      source:
                        type: string
                        enum:
                          - FIRM_UPLOAD
                          - TAVRN_DEFAULT
                    required:
                      - family
                      - source
            generic:
              type: object
              nullable: true
              allOf:
                - $ref: '#/components/schemas/RequestorFile'
            config_revision:
              type: integer
              nullable: true
        correspondence:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorCorrespondence'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - is_default
        - provider_invoice_limit
        - effective_provider_invoice_limit
        - letter_of_rep
        - rfc_form
        - affidavits
        - correspondence
        - created_at
        - updated_at
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: validation_error
            message:
              type: string
              description: Human-readable error message
              example: The patient.date_of_birth field is required
    RequestorUploadReference:
      type: object
      properties:
        upload_id:
          type: string
          format: uuid
          description: >-
            Upload ID from POST /v2/requestors/sign-upload after uploading the
            PDF.
      required:
        - upload_id
      additionalProperties: false
      nullable: true
    RequestorAffidavitsInput:
      type: object
      properties:
        declared_families:
          type: array
          maxItems: 3
          uniqueItems: true
          items:
            type: string
            enum:
              - records
              - billing
              - radiology
          description: >-
            Replace declared families; [] records an explicit answer of none,
            including on a new profile. If omitted without exact documents,
            preserves the previous answer or leaves it unanswered. Supplied
            exact-document families are added to the existing declaration when
            this field is omitted. If supplied with documents, every uploaded
            family must be included.
        documents:
          type: array
          maxItems: 3
          items:
            type: object
            properties:
              family:
                type: string
                enum:
                  - records
                  - billing
                  - radiology
              upload_id:
                type: string
                format: uuid
            required:
              - family
              - upload_id
            additionalProperties: false
          description: >-
            Replace all exact-family documents, with at most one per family. An
            empty array removes them all; omission preserves them. Supplied
            families are added to the declaration unless declared_families is
            explicitly provided. Updating exact-family documents leaves generic
            unchanged.
        generic:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorUploadReference'
      minProperties: 1
      additionalProperties: false
      description: >-
        Generic fallback and exact-family documents are independent. Set generic
        to null to remove it. Referenced PDFs must be readable, unencrypted, and
        at most 25 MiB.
    RequestorCorrespondence:
      type: object
      properties:
        custom_letter_body:
          type: string
          nullable: true
          maxLength: 10000
        custom_letter_body_requires_rfc:
          type: boolean
          nullable: true
        notice:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorCorrespondenceNotice'
        billing_request:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RequestorBillingInstructions'
      additionalProperties: false
      nullable: true
      description: >-
        Omitted settings stay unchanged on update. Null clears nullable
        settings. A supplied notice replaces the previous notice; supplied
        billing_request fields merge with existing fields.
    RequestorFile:
      type: object
      required:
        - file_name
        - page_count
        - uploaded_at
      properties:
        file_name:
          type: string
          nullable: true
        page_count:
          type: integer
          nullable: true
        uploaded_at:
          type: string
          nullable: true
          format: date-time
      nullable: true
      description: Document metadata returned with a Requestor.
    RequestorCorrespondenceNotice:
      type: object
      properties:
        title:
          type: string
          maxLength: 500
        body:
          type: string
          maxLength: 10000
        suppress_prepayment_sentence:
          type: boolean
          nullable: true
        suppress_provider_cost_threshold_paragraph:
          type: boolean
          nullable: true
      required:
        - title
        - body
      additionalProperties: false
      nullable: true
    RequestorBillingInstructions:
      type: object
      properties:
        special_instruction:
          type: string
          nullable: true
          maxLength: 10000
        cover_letter_ask:
          type: string
          nullable: true
          maxLength: 10000
        auth_scope_stamp_label:
          type: string
          nullable: true
          maxLength: 500
      additionalProperties: false
      nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key authentication. Use format: `Authorization: Bearer
        tavrn_sk_live_...`

````