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

# Restore a document type field

> Reads an archived field of the firm’s again from documents read from now on. Documents read while it was archived are not read again. Only an admin can call this.



## OpenAPI

````yaml /openapi/advisor.json post /document_types/{type}/fields/{field}/restore
openapi: 3.1.0
info:
  title: Redbark Advisor API
  version: 2.0.0
  description: >-
    Read and write access to one advice firm in Redbark Advisor: clients,
    checklists, documents, money, messages, reports, team and webhooks. Send an
    API key or a connected app’s access token as a bearer token. A credential
    carries scopes, one read and one write per area, and each call says the
    scope it needs. A write scope brings its read scope. Each key may make 120
    requests a minute.
servers:
  - url: https://advisor.redbark.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Firm
    description: The firm, its name and its branding.
  - name: Team
    description: Team members and their roles.
  - name: Clients
    description: Clients, their people and portal invites.
  - name: Checklists
    description: Checklist templates, the checklists sent to clients and their answers.
  - name: Documents
    description: Documents clients upload and the details read from them.
  - name: Money
    description: Bank connections, accounts, balances and transactions.
  - name: Document types
    description: Document types, their fields and the client facts they fill.
  - name: Messages
    description: Messages between the firm and clients.
  - name: Reports
    description: Reports exported for clients.
  - name: Webhooks
    description: Webhook endpoints and their deliveries.
  - name: Webhook events
    description: Events sent to your webhook endpoints.
paths:
  /document_types/{type}/fields/{field}/restore:
    post:
      tags:
        - Document types
      summary: Restore a document type field
      description: >-
        Reads an archived field of the firm’s again from documents read from now
        on. Documents read while it was archived are not read again. Only an
        admin can call this.
      operationId: restore_document_type_field
      parameters:
        - name: type
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The document type key, such as payslip, from list_document_types.
        - name: field
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: >-
              The field key, such as firm_salary_sacrifice, from
              get_document_type.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTypeField'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key or access token is missing, wrong, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            subscription_required: the firm has no active subscription, so it
            cannot add or invite clients or send checklists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The credential lacks the scope this call needs, the call is for
            admins only, or the member it acts as has left the firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The resource is in a state that does not allow this, such as an
            archived client, or client_limit_reached: the plan’s 20 active
            clients are in use.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests. See the Retry-After header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Something went wrong on our side. Try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - document_types:write
components:
  schemas:
    DocumentTypeField:
      type: object
      properties:
        object:
          type: string
          enum:
            - document_type_field
        id:
          anyOf:
            - type: string
            - type: 'null'
          description: Null for a built-in field.
        key:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
            - text
            - date
            - amount
            - number
            - percent
          description: >-
            text, date (YYYY-MM-DD), amount (dollars), number or percent. A
            field that fills a fact holds the same type as the fact.
        section:
          type: string
        required:
          type: boolean
        instruction:
          anyOf:
            - type: string
            - type: 'null'
          description: What the reader is told. Only the firm's own fields show theirs.
        origin:
          type: string
          enum:
            - redbark
            - firm
          description: >-
            redbark for Redbark's own, which cannot be changed; firm for the
            firm's own.
        archived:
          type: boolean
          description: >-
            No longer read from new documents. Values already read stay and
            still show.
        fact_key:
          anyOf:
            - type: string
            - type: 'null'
          description: The client fact an approved value fills, or null.
      required:
        - object
        - id
        - key
        - label
        - type
        - section
        - required
        - instruction
        - origin
        - archived
        - fact_key
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              anyOf:
                - type: string
                - type: 'null'
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          additionalProperties: true
      required:
        - error
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A firm API key, shown once when it is made, or a connected app’s OAuth
        access token. Each operation lists the scope it needs, such as
        clients:write.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.