Skip to main content
POST
Generates the values of a deal AI field on a list of deals or on the deals of a view, asynchronously. By default only the deals without a value are processed. Set estimateOnly to get the deal count and estimatedCredits without starting the generation. See Generations.

Authorizations

X-Claap-Key
string
header
required

Path Parameters

fieldId
string
required

Deal AI field identifier

Body

application/json
creatorEmail
string<email>
required

Email address of the generation author. It must belong to an active workspace member.

dealIds
string[]

Generate the field on these deals, at most 333 identifiers: use viewId for larger sets. Exactly one of dealIds and viewId is required.

Required array length: 1 - 333 elements
viewId
string

Generate the field on the deals of this view instead of listing their identifiers. Use GET /v1/deals/views to discover views.

mode
enum<string>
default:FillMissing

FillMissing only generates the deals without a value, Recompute regenerates every deal.

Available options:
FillMissing,
Recompute
estimateOnly
boolean
default:false

Return totalCount and estimatedCredits without starting the generation.

Response

Deal AI field generation was successfully started

result
object
required

The outcome of an AI field generation request.