Run an enrichment column

Developing

PATCH

https://api.clay.com/v3/tables/{TABLE_ID}/run

Runs an enrichment column on specified records in the table. This endpoint executes the enrichment for a specific field/column on a set of records.

Input:

fieldIds: Array of column IDs to run the enrichment on

runRecords: Specify which records to run using viewIdTopRecords

viewId: The view ID to run records from

numRecords: Number of rows to run (e.g., 10 runs the first 10 rows). Remove this parameter if you want to run all records in the view.

Use Cases:

Execute enrichment on the first N rows of a view

Run specific columns/fields for selected records

Trigger data enrichment workflows programmatically

Run enrichment on all records by omitting numRecords

Request

Path Params

Header Params

Body Params application/x-www-form-urlencodedRequired

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.clay.com/v3/tables/<TABLE_ID>/run' \
--header 'Cookie: {YOUR_CLAY_COOKIES}' \
--data-urlencode '{"fieldIds":["{FIELD_ID}"],"runRecords":{"viewIdTopRecords":{"viewId":"{VIEW_ID}","numRecords":10}},"callerName":"API"}='

Response Example

{}

Modified at 2026-01-14 06:51:34

Delete all rows from a table

Count number of row in a Table