ClarifyAPI
Records

Autofill record fields

Fills fields on records by running each field's autofill: enrichment, AI, a formula or signals. Pick records by record_ids and fields by fields (all autofill fields when left out). Fills run in the background and write to the records. Set max_credits to cap what AI fields may spend.

POST
/workspaces/{workspace}/objects/{object}/records/autofill
Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

object*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation and batches its live updates, so open views can lag by up to 20 seconds.

Header Parameters

clarify-version?string

The API version for this request. Send 2026-01 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/workspaces/string/objects/string/records/autofill" \  -H "clarify-version: 2026-01" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "autofill",      "attributes": {        "record_ids": [          "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71"        ],        "fields": [          "email",          "icp_fit"        ],        "only_empty": true      }    }  }'
{  "meta": {    "credits": 3,    "enrichment_records": 1,    "fields": [      {        "field": "email",        "type": "enrichment",        "record_count": 1,        "credits": 0      },      {        "field": "icp_fit",        "type": "ai",        "record_count": 1,        "credits": 3      }    ]  }}