Deal
Update deal AI field
Update a deal AI field. The update is a full replace: always send the complete field definition, as omitted optional attributes are cleared. Updating a field does not regenerate the values already produced; the new definition applies to deals as new activity comes in.
PUT
/
v1
/
deals
/
fields
/
{fieldId}
cURL
curl --request PUT \
--url https://api.claap.io/v1/deals/fields/{fieldId} \
--header 'Content-Type: application/json' \
--header 'X-Claap-Key: <api-key>' \
--data '
{
"title": "Confirmed budget",
"prompt": {
"outputType": "Checkbox",
"prompt": "Has the prospect confirmed a budget for this deal?"
}
}
'import requests
url = "https://api.claap.io/v1/deals/fields/{fieldId}"
payload = {
"title": "Confirmed budget",
"prompt": {
"outputType": "Checkbox",
"prompt": "Has the prospect confirmed a budget for this deal?"
}
}
headers = {
"X-Claap-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Confirmed budget',
prompt: {
outputType: 'Checkbox',
prompt: 'Has the prospect confirmed a budget for this deal?'
}
})
};
fetch('https://api.claap.io/v1/deals/fields/{fieldId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.claap.io/v1/deals/fields/{fieldId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Confirmed budget',
'prompt' => [
'outputType' => 'Checkbox',
'prompt' => 'Has the prospect confirmed a budget for this deal?'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Claap-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.claap.io/v1/deals/fields/{fieldId}"
payload := strings.NewReader("{\n \"title\": \"Confirmed budget\",\n \"prompt\": {\n \"outputType\": \"Checkbox\",\n \"prompt\": \"Has the prospect confirmed a budget for this deal?\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Claap-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.claap.io/v1/deals/fields/{fieldId}")
.header("X-Claap-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Confirmed budget\",\n \"prompt\": {\n \"outputType\": \"Checkbox\",\n \"prompt\": \"Has the prospect confirmed a budget for this deal?\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.claap.io/v1/deals/fields/{fieldId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Confirmed budget\",\n \"prompt\": {\n \"outputType\": \"Checkbox\",\n \"prompt\": \"Has the prospect confirmed a budget for this deal?\"\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"fieldId": "DealAiSection#Nb4Hj7Ky2Fs9Lm1Qd6Vp3",
"title": "Confirmed budget",
"kind": "Field",
"outputType": "Checkbox",
"prompt": "Has the prospect confirmed a budget for this deal?",
"authorId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
"createdAt": "2026-05-14T09:30:00Z"
}
}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
Path Parameters
Deal AI field identifier
Body
application/json
Response
Deal AI field was successfully updated
An AI field: a custom prompt with a typed output, evaluated by AI. Usable as an AiSection view column through its fieldId.
Show child attributes
Show child attributes
⌘I
cURL
curl --request PUT \
--url https://api.claap.io/v1/deals/fields/{fieldId} \
--header 'Content-Type: application/json' \
--header 'X-Claap-Key: <api-key>' \
--data '
{
"title": "Confirmed budget",
"prompt": {
"outputType": "Checkbox",
"prompt": "Has the prospect confirmed a budget for this deal?"
}
}
'import requests
url = "https://api.claap.io/v1/deals/fields/{fieldId}"
payload = {
"title": "Confirmed budget",
"prompt": {
"outputType": "Checkbox",
"prompt": "Has the prospect confirmed a budget for this deal?"
}
}
headers = {
"X-Claap-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Confirmed budget',
prompt: {
outputType: 'Checkbox',
prompt: 'Has the prospect confirmed a budget for this deal?'
}
})
};
fetch('https://api.claap.io/v1/deals/fields/{fieldId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.claap.io/v1/deals/fields/{fieldId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Confirmed budget',
'prompt' => [
'outputType' => 'Checkbox',
'prompt' => 'Has the prospect confirmed a budget for this deal?'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Claap-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.claap.io/v1/deals/fields/{fieldId}"
payload := strings.NewReader("{\n \"title\": \"Confirmed budget\",\n \"prompt\": {\n \"outputType\": \"Checkbox\",\n \"prompt\": \"Has the prospect confirmed a budget for this deal?\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Claap-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.claap.io/v1/deals/fields/{fieldId}")
.header("X-Claap-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Confirmed budget\",\n \"prompt\": {\n \"outputType\": \"Checkbox\",\n \"prompt\": \"Has the prospect confirmed a budget for this deal?\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.claap.io/v1/deals/fields/{fieldId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Confirmed budget\",\n \"prompt\": {\n \"outputType\": \"Checkbox\",\n \"prompt\": \"Has the prospect confirmed a budget for this deal?\"\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"fieldId": "DealAiSection#Nb4Hj7Ky2Fs9Lm1Qd6Vp3",
"title": "Confirmed budget",
"kind": "Field",
"outputType": "Checkbox",
"prompt": "Has the prospect confirmed a budget for this deal?",
"authorId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
"createdAt": "2026-05-14T09:30:00Z"
}
}