Create Smart Tag

Creates a new smart tag for the company.

Required fields:

• tagName - Tag identifier (must match pattern /^AII[A-Za-z0-9]+$/)
• tagDisplayName - Display name for the tag
• tagCategories - Array of categories (e.g., [‘quote’, ‘policy’])

Optional fields:

• tagDescription - Description of what the tag does
• tagData - Custom smart tag configuration (see below)

Custom Smart Tag Types:

When creating a custom smart tag, specify the type field in tagData. Available types include:

Coverage & Premium Types:

• coveragePremium - Coverage premium amount
• coveragePremiumTax - Coverage premium tax
• coveragePremiumPlusTax - Coverage premium plus tax
• specificCoverageProperty - Specific coverage property
• specificCoverageLimit - Specific coverage limit

Policy Types:

• policy - Policy-level data
• policyLevelRatingOutput - Policy-level rating outputs
• policyList - List of policies
• policyTable - Policy data table
• firstPolicyCoverage - First policy coverage
• firstPolicyLimit - First policy limit

Insured Types:

• insuredsSchedule - Schedule of insureds
• selectedInsured - Selected insured data
• primaryInsured - Primary insured information
• primaryInsuredCoverageRatingOutput - Primary insured coverage rating output
• primaryInsuredCoverageRatingOutputTable - Primary insured coverage rating output table
• insuredCoverageRatingOutputsTable - Insured coverage ratings outputs table
• summedInsuredCoverageRatings - Summed insured coverage ratings
• insuredClaimsTable - Insured claims table

Other Types:

• dynamic - Dynamic field lookup (most flexible for custom fields)
• staticTable - Static table data
• stateSpecificDisclosures - State-specific disclosure text
• eventFinancialAmount - Event financial amount

Allowed tagData fields:

• type - Smart tag type (required if using custom smart tags)
• fieldId - Field identifier
• fieldKey - Field key
• fieldLabel - Field label
• fieldSection - Field section
• entityType - Entity type
• outputLabel - Output label
• coverageKey - Coverage key
• filters - Filter conditions (array)
• columns - Column definitions (array)

Required permission: company:update

POST /api/external/companies/{companyId}/smart-tags

cURL

minimal

curl --request POST \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/smart-tags \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tagName": "AIIBaseRevenue",
  "tagDisplayName": "Base Revenue",
  "tagCategories": [
    "policy"
  ]
}
'

201

success

{
  "id": "550e8400-e29b-41d4-a716-446655440003"
}

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 creating a smart tag

tagName · string · required

Tag identifier (required). Must match pattern /^AII[A-Za-z0-9]+$/. Must start with "AII" followed by alphanumeric characters only.

Pattern: ^AII[A-Za-z0-9]+$

Example:

"AIIMyCustomTag"

tagDisplayName · string · required

Display name for the tag (required)

Example:

"My Custom Tag"

tagCategories · enum<string>[] · required

Categories the tag can be used in. Determines which contexts the tag is available in:

• policy - Adhoc generated forms for a policy
• quote - Forms generated during quote wizard
• policy-insured - Adhoc generated forms with both a policy and an insured
• quote-insured - Forms generated during quote wizard for one insured
• insured - Adhoc generated forms with an insured and related data
• event - Adhoc generated forms with an event and related data
• payee - Adhoc generated forms for a payee with payment and invoice data

Available options: policy, policy-insured, quote, quote-insured, insured, event, payee

Example:

["quote", "policy"]

tagDescription · string

Description of what the tag does

tagData · object

Arbitrary JSON metadata. Can contain any valid JSON structure. Common uses: storing type classifications, configuration, or custom properties.

Example:

{ "type": "text" }

Response

201

application/json

Smart tag created successfully

id · string<uuid>

The ID of the created smart tag