Skip to main content
POST
cURL
Creates a deal AI field, evaluated by AI against all the activity of each deal (recordings and emails). creatorEmail must belong to an active workspace member, who becomes the field author. The field is evaluated for deals as new activity comes in; no values are generated for deals whose activity does not change.

Authorizations

X-Claap-Key
string
header
required

Body

application/json
title
string
required

The field title.

prompt
object
required

The prompt evaluated by the AI to fill the field.

creatorEmail
string<email>
required

Email address of the field creator. It must belong to an active workspace member, who becomes the field author.

crmField
object

The CRM property to map the field to. When omitted, the field is not mapped to the CRM.

Response

Deal AI field was successfully created

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.