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 tagtagCategories - Array of categories (e.g., [‘quote’, ‘policy’])Optional fields:
tagDescription - Description of what the tag doestagData - 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 amountcoveragePremiumTax - Coverage premium taxcoveragePremiumPlusTax - Coverage premium plus taxspecificCoverageProperty - Specific coverage propertyspecificCoverageLimit - Specific coverage limitPolicy Types:
policy - Policy-level datapolicyLevelRatingOutput - Policy-level rating outputspolicyList - List of policiespolicyTable - Policy data tablefirstPolicyCoverage - First policy coveragefirstPolicyLimit - First policy limitInsured Types:
insuredsSchedule - Schedule of insuredsselectedInsured - Selected insured dataprimaryInsured - Primary insured informationprimaryInsuredCoverageRatingOutput - Primary insured coverage rating outputprimaryInsuredCoverageRatingOutputTable - Primary insured coverage rating output tableinsuredCoverageRatingOutputsTable - Insured coverage ratings outputs tablesummedInsuredCoverageRatings - Summed insured coverage ratingsinsuredClaimsTable - Insured claims tableOther Types:
dynamic - Dynamic field lookup (most flexible for custom fields)staticTable - Static table datastateSpecificDisclosures - State-specific disclosure texteventFinancialAmount - Event financial amountAllowed tagData fields:
type - Smart tag type (required if using custom smart tags)fieldId - Field identifierfieldKey - Field keyfieldLabel - Field labelfieldSection - Field sectionentityType - Entity typeoutputLabel - Output labelcoverageKey - Coverage keyfilters - Filter conditions (array)columns - Column definitions (array)Required permission: company:update
API key authentication. Include your key in the Authorization header: Authorization: ApiKey YOUR-API-KEY
Company identifier
Request body for creating a smart tag
Tag identifier (required). Must match pattern /^AII[A-Za-z0-9]+$/. Must start with "AII" followed by alphanumeric characters only.
"AIIMyCustomTag"
Display name for the tag (required)
"My Custom Tag"
Categories the tag can be used in. Determines which contexts the tag is available in:
policy - Adhoc generated forms for a policyquote - Forms generated during quote wizardpolicy-insured - Adhoc generated forms with both a policy and an insuredquote-insured - Forms generated during quote wizard for one insuredinsured - Adhoc generated forms with an insured and related dataevent - Adhoc generated forms with an event and related datapayee - Adhoc generated forms for a payee with payment and invoice datapolicy, policy-insured, quote, quote-insured, insured, event, payee ["quote", "policy"]Description of what the tag does
Arbitrary JSON metadata. Can contain any valid JSON structure. Common uses: storing type classifications, configuration, or custom properties.
{ "type": "text" }Smart tag created successfully
The ID of the created smart tag