Skip to main content
PUT
cURL
The update is a full replace: always send the complete field definition, as an omitted crmField is cleared. Updating a field does not regenerate the values already produced; the new definition applies to deals as new activity comes in.

Authorizations

X-Claap-Key
string
header
required

Path Parameters

fieldId
string
required

Deal AI field identifier

Body

application/json
title
string
required

The field title.

prompt
object
required

The prompt evaluated by the AI to fill the field.

crmField
object

The CRM property to map the field to. When omitted, the CRM mapping is removed.

Response

Deal AI field was successfully updated

result
object
required

An AI field: a custom prompt with a typed output, evaluated by AI. Usable as an AiSection view column through its fieldId.