This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
Unknown settings are ignored. When duplicate_mode is skip or upsert, match_rule_id must point to a column that supports incoming matching; its identity strategy is authoritative. Changing the match column clears an omitted stale strategy. This route updates configuration and does not ingest a record.
Path parameters
table_idrequiredstring
Target table ID.
| Name | Type | Description |
|---|---|---|
| table_idrequired | string | Target table ID. |
Body parameters
match_rule_id· optionalstring|null
Optional match rule id or column key. Required when duplicate_mode is skip or upsert; it must identify a supported incoming-match column.
match_column· optionalstring|null
Alias for match_rule_id; ignored when match_rule_id is also supplied.
match_strategy· optionalstring|null
Optional strategy: domain, email, linkedin_url, external_id, or exact_text. With duplicate protection enabled, source column semantics determine the strategy.
duplicate_mode· optionalstring
allow (default), skip, or upsert. skip/upsert require a valid match_rule_id; unsupported modes return 422.
merge_mode· optionalstring
fill_empty (default) or overwrite_mapped. Other values return 422.
event_stream_sample_capture_enabled· optionalboolean
Enable or disable capture of the next incoming sample for event-stream setup. Enabling resets prior sample state.
| Name | Type | Description |
|---|---|---|
| match_rule_id | string|null | Optional match rule id or column key. Required when duplicate_mode is skip or upsert; it must identify a supported incoming-match column. |
| match_column | string|null | Alias for match_rule_id; ignored when match_rule_id is also supplied. |
| match_strategy | string|null | Optional strategy: domain, email, linkedin_url, external_id, or exact_text. With duplicate protection enabled, source column semantics determine the strategy. |
| duplicate_mode | string | allow (default), skip, or upsert. skip/upsert require a valid match_rule_id; unsupported modes return 422. |
| merge_mode | string | fill_empty (default) or overwrite_mapped. Other values return 422. |
| event_stream_sample_capture_enabled | boolean | Enable or disable capture of the next incoming sample for event-stream setup. Enabling resets prior sample state. |
Errors
| Status | Meaning |
|---|---|
| 401 | Invalid API key or missing auth. |
| 403 | Missing tables:write scope or table access denied. |
| 404 | Table not found. |
| 422 | Invalid match_strategy, duplicate_mode, or merge_mode. |
| 422 | Invalid request body or field type. |
