Skip to main content
POST
/
v1
/
table
/
{table_uuid}
/
add-enrichment
curl --request POST \
  --url https://api.databar.ai/v1/table/{table_uuid}/add-enrichment \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <x-apikey>' \
  --data '
{
  "enrichment": 1,
  "mapping": {
    "email": {
      "value": "42902e11-fa09-4abd-a627-77c07fc40cde",
      "type": "mapping"
    },
    "country": {
      "value": "US",
      "type": "simple"
    }
  }
}
'
{
  "id": 42,
  "enrichment_name": "Email Verification"
}

Mapping format

The mapping object links enrichment parameters to table columns (or hardcoded values). Each key is an enrichment parameter slug (from GET /v1/enrichments/{id}params[].name). Each value is one of:
TypeWhen to usevalue field
"mapping"Read value from a column per rowHuman-readable column name (e.g. "email")
"simple"Same static value for every rowThe literal value (e.g. "US")
{
  "enrichment": 123,
  "mapping": {
    "email": {
      "type": "mapping",
      "value": "email"
    },
    "country": {
      "type": "simple",
      "value": "US"
    }
  }
}

After adding

The response body is {}. To get the table-enrichment ID required by POST /v1/table/{table_uuid}/run-enrichment/{id}, call:
GET /v1/table/{table_uuid}/enrichments
and use the id field of the newly added entry.

Headers

x-apikey
string
required

API Key for authentication

Path Parameters

table_uuid
string<uuid>
required

The UUID of the table

Body

application/json
enrichment
integer
required

The enrichment ID to add.

mapping
Mapping · object
required

Parameter mapping. Keys are enrichment parameter slugs.

launch_strategy
enum<string>
default:run_on_click

When to run: 'run_on_click' (manual only) or 'run_on_update' (auto-trigger when mapped input columns change).

Available options:
run_on_click,
run_on_update

Response

Enrichment added successfully

id
integer
required
enrichment_name
string
required