Import Configuration

curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/import \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
  "googleOAuthToken": "ya29.a0AfH6SM..."
}
'

{
  "success": true,
  "message": "Configuration imported successfully"
}

Configuration Management

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

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.

This endpoint requires an API key created with the FMV1_CONFIGURATION_MANAGER role. See Authentication for how to create API keys with specific roles.

POST

api

external

companies

{companyId}

configuration

import

Import Configuration

curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/import \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
  "googleOAuthToken": "ya29.a0AfH6SM..."
}
'

{
  "success": true,
  "message": "Configuration imported successfully"
}

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId

string<uuid>

required

Company identifier

Body

application/json

Request body for FMV1 configuration spreadsheet operations

spreadsheetId

string

required

The ID of the target Google Spreadsheet

googleOAuthToken

string

required

A valid Google OAuth2 access token with Google Sheets access permission

Response

Import completed successfully

Result of importing FMV1 configuration from a Google Spreadsheet

success

boolean

required

Whether the import completed successfully

message

string

Human-readable status message

Compare Configuration Get Configuration

⌘I

Getting Started

Submissions

Quotes

Assignees

Notes

Events

Brokerages

Brokers

Payees

Transaction Categories

Event Financials

Policies

Exposures

Attorneys

Lawsuits

Defendants

Coverage Types

Smart Tags

Field Model V1

Reference

Import Configuration

Authorizations

Path Parameters

Body

Response