Skip to main content
POST
/
api
/
external
/
companies
/
{companyId}
/
smart-tags
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"
  ]
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440003"
}

Authorizations

Authorization
string
header
required

API key authentication. Include your key in the Authorization header: Authorization: ApiKey YOUR-API-KEY

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.

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

Smart tag created successfully

id
string<uuid>

The ID of the created smart tag