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

# Import Configuration

> Imports FMV1 configuration from a Google Spreadsheet into the database. This runs the
full pipeline: validate, parse, compare, and apply changes.

If validation fails, no changes are applied and the response returns `success: false`
with a `message` describing the failure.

The caller must provide their own Google OAuth2 access token with read permission on the
target spreadsheet.

**Required permission:** `company.configuration:import`

<Warning>
This endpoint modifies the company's FMV1 configuration. Changes take effect immediately
and affect all users of the company. Use the **compare** endpoint first to preview changes.
</Warning>

<Note>
This endpoint requires an API key created with the **FMV1_CONFIGURATION_MANAGER** role.
See [Authentication](/api-reference/authentication) for how to create API keys with specific roles.
</Note>




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/external/companies/{companyId}/configuration/import
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://app.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/external/companies/{companyId}/configuration/import:
    post:
      tags:
        - FMV1 Configuration
      summary: Import Configuration
      description: >
        Imports FMV1 configuration from a Google Spreadsheet into the database.
        This runs the

        full pipeline: validate, parse, compare, and apply changes.


        If validation fails, no changes are applied and the response returns
        `success: false`

        with a `message` describing the failure.


        The caller must provide their own Google OAuth2 access token with read
        permission on the

        target spreadsheet.


        **Required permission:** `company.configuration:import`


        <Warning>

        This endpoint modifies the company's FMV1 configuration. Changes take
        effect immediately

        and affect all users of the company. Use the **compare** endpoint first
        to preview changes.

        </Warning>


        <Note>

        This endpoint requires an API key created with the
        **FMV1_CONFIGURATION_MANAGER** role.

        See [Authentication](/api-reference/authentication) for how to create
        API keys with specific roles.

        </Note>
      operationId: importFmv1Configuration
      parameters:
        - $ref: '#/components/parameters/companyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationSpreadsheetRequest'
            examples:
              default:
                summary: Import configuration from spreadsheet
                value:
                  spreadsheetId: 1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms
                  googleOAuthToken: ya29.a0AfH6SM...
      responses:
        '200':
          description: Import completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationImportResponse'
              examples:
                success:
                  summary: Successful import
                  value:
                    success: true
                    message: Configuration imported successfully
                validationFailure:
                  summary: Validation failure (no changes applied)
                  value:
                    success: false
                    message: >-
                      Validation failed: Unknown column 'Foo' in sheet 'Field
                      Definitions'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    ConfigurationSpreadsheetRequest:
      type: object
      description: Request body for FMV1 configuration spreadsheet operations
      required:
        - spreadsheetId
        - googleOAuthToken
      properties:
        spreadsheetId:
          type: string
          description: The ID of the target Google Spreadsheet
        googleOAuthToken:
          type: string
          description: >-
            A valid Google OAuth2 access token with Google Sheets access
            permission
    ConfigurationImportResponse:
      type: object
      description: Result of importing FMV1 configuration from a Google Spreadsheet
      required:
        - success
      properties:
        success:
          type: boolean
          description: Whether the import completed successfully
        message:
          type: string
          description: Human-readable status message
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      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: 'submissionId: Required field is missing'
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: UNAUTHORIZED
                  message: Authorization header is required
            bearerTokenNotAllowed:
              summary: Bearer token used instead of API key
              value:
                error:
                  code: UNAUTHORIZED
                  message: External API endpoints require API key authentication
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: FORBIDDEN
                  message: Insufficient permissions to perform this action
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: INTERNAL_ERROR
                  message: An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Include your API key in the Authorization
        header.

````