Create a deal
curl --request POST \
--url https://api.chatsailer.com/v1/deals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pipeline_id": "pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"stage_id": "stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"title": "<string>",
"contact_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"custom_fields": {},
"expected_close_date": "2023-11-07T05:31:56Z",
"external_id": "crm-48213",
"lost_justification": "<string>",
"lost_reason_id": "lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"organization_id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"probability": 50,
"status": "open",
"value": 123,
"visibility": "company"
}
'import requests
url = "https://api.chatsailer.com/v1/deals"
payload = {
"pipeline_id": "pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"stage_id": "stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"title": "<string>",
"contact_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"custom_fields": {},
"expected_close_date": "2023-11-07T05:31:56Z",
"external_id": "crm-48213",
"lost_justification": "<string>",
"lost_reason_id": "lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"organization_id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"probability": 50,
"status": "open",
"value": 123,
"visibility": "company"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pipeline_id: 'pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
stage_id: 'stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
title: '<string>',
contact_id: 'con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
custom_fields: {},
expected_close_date: '2023-11-07T05:31:56Z',
external_id: 'crm-48213',
lost_justification: '<string>',
lost_reason_id: 'lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
organization_id: 'org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
owner_id: 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
probability: 50,
status: 'open',
value: 123,
visibility: 'company'
})
};
fetch('https://api.chatsailer.com/v1/deals', 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.chatsailer.com/v1/deals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pipeline_id' => 'pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'stage_id' => 'stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'title' => '<string>',
'contact_id' => 'con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'custom_fields' => [
],
'expected_close_date' => '2023-11-07T05:31:56Z',
'external_id' => 'crm-48213',
'lost_justification' => '<string>',
'lost_reason_id' => 'lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'organization_id' => 'org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'owner_id' => 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'probability' => 50,
'status' => 'open',
'value' => 123,
'visibility' => 'company'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.chatsailer.com/v1/deals"
payload := strings.NewReader("{\n \"pipeline_id\": \"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"stage_id\": \"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"title\": \"<string>\",\n \"contact_id\": \"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"custom_fields\": {},\n \"expected_close_date\": \"2023-11-07T05:31:56Z\",\n \"external_id\": \"crm-48213\",\n \"lost_justification\": \"<string>\",\n \"lost_reason_id\": \"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"organization_id\": \"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"owner_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"probability\": 50,\n \"status\": \"open\",\n \"value\": 123,\n \"visibility\": \"company\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.chatsailer.com/v1/deals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline_id\": \"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"stage_id\": \"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"title\": \"<string>\",\n \"contact_id\": \"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"custom_fields\": {},\n \"expected_close_date\": \"2023-11-07T05:31:56Z\",\n \"external_id\": \"crm-48213\",\n \"lost_justification\": \"<string>\",\n \"lost_reason_id\": \"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"organization_id\": \"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"owner_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"probability\": 50,\n \"status\": \"open\",\n \"value\": 123,\n \"visibility\": \"company\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chatsailer.com/v1/deals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline_id\": \"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"stage_id\": \"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"title\": \"<string>\",\n \"contact_id\": \"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"custom_fields\": {},\n \"expected_close_date\": \"2023-11-07T05:31:56Z\",\n \"external_id\": \"crm-48213\",\n \"lost_justification\": \"<string>\",\n \"lost_reason_id\": \"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"organization_id\": \"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"owner_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"probability\": 50,\n \"status\": \"open\",\n \"value\": 123,\n \"visibility\": \"company\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"id": "deal_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"pipeline_id": "pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"stage_id": "stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "private",
"contact_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"custom_fields": {},
"expected_close_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"lost_justification": "<string>",
"lost_reason": "<string>",
"lost_reason_id": "lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"object": "deal",
"organization": {
"created_at": "2023-11-07T05:31:56Z",
"id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "private",
"custom_fields": {},
"external_id": "<string>",
"object": "organization",
"owner": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"tags": [
{
"id": "tag_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"name": "<string>",
"color": "<string>",
"object": "tag"
}
],
"website": "<string>"
},
"organization_id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"owner": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"probability": 123,
"score": "cold",
"stage_changed_at": "2023-11-07T05:31:56Z",
"status": "open",
"tags": [
{
"id": "tag_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"name": "<string>",
"color": "<string>",
"object": "tag"
}
],
"value": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Deals
Create a deal
Creates a deal in a pipeline stage.
pipeline_id and stage_id must belong together — list GET /v1/pipelines for a valid pair. At least one of contact_id or organization_id is required: a deal with neither is with nobody.
POST
/
v1
/
deals
Create a deal
curl --request POST \
--url https://api.chatsailer.com/v1/deals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pipeline_id": "pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"stage_id": "stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"title": "<string>",
"contact_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"custom_fields": {},
"expected_close_date": "2023-11-07T05:31:56Z",
"external_id": "crm-48213",
"lost_justification": "<string>",
"lost_reason_id": "lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"organization_id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"probability": 50,
"status": "open",
"value": 123,
"visibility": "company"
}
'import requests
url = "https://api.chatsailer.com/v1/deals"
payload = {
"pipeline_id": "pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"stage_id": "stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"title": "<string>",
"contact_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"custom_fields": {},
"expected_close_date": "2023-11-07T05:31:56Z",
"external_id": "crm-48213",
"lost_justification": "<string>",
"lost_reason_id": "lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"organization_id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"probability": 50,
"status": "open",
"value": 123,
"visibility": "company"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pipeline_id: 'pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
stage_id: 'stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
title: '<string>',
contact_id: 'con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
custom_fields: {},
expected_close_date: '2023-11-07T05:31:56Z',
external_id: 'crm-48213',
lost_justification: '<string>',
lost_reason_id: 'lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
organization_id: 'org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
owner_id: 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
probability: 50,
status: 'open',
value: 123,
visibility: 'company'
})
};
fetch('https://api.chatsailer.com/v1/deals', 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.chatsailer.com/v1/deals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pipeline_id' => 'pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'stage_id' => 'stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'title' => '<string>',
'contact_id' => 'con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'custom_fields' => [
],
'expected_close_date' => '2023-11-07T05:31:56Z',
'external_id' => 'crm-48213',
'lost_justification' => '<string>',
'lost_reason_id' => 'lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'organization_id' => 'org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'owner_id' => 'usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4',
'probability' => 50,
'status' => 'open',
'value' => 123,
'visibility' => 'company'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.chatsailer.com/v1/deals"
payload := strings.NewReader("{\n \"pipeline_id\": \"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"stage_id\": \"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"title\": \"<string>\",\n \"contact_id\": \"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"custom_fields\": {},\n \"expected_close_date\": \"2023-11-07T05:31:56Z\",\n \"external_id\": \"crm-48213\",\n \"lost_justification\": \"<string>\",\n \"lost_reason_id\": \"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"organization_id\": \"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"owner_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"probability\": 50,\n \"status\": \"open\",\n \"value\": 123,\n \"visibility\": \"company\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.chatsailer.com/v1/deals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline_id\": \"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"stage_id\": \"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"title\": \"<string>\",\n \"contact_id\": \"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"custom_fields\": {},\n \"expected_close_date\": \"2023-11-07T05:31:56Z\",\n \"external_id\": \"crm-48213\",\n \"lost_justification\": \"<string>\",\n \"lost_reason_id\": \"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"organization_id\": \"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"owner_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"probability\": 50,\n \"status\": \"open\",\n \"value\": 123,\n \"visibility\": \"company\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chatsailer.com/v1/deals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline_id\": \"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"stage_id\": \"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"title\": \"<string>\",\n \"contact_id\": \"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"custom_fields\": {},\n \"expected_close_date\": \"2023-11-07T05:31:56Z\",\n \"external_id\": \"crm-48213\",\n \"lost_justification\": \"<string>\",\n \"lost_reason_id\": \"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"organization_id\": \"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"owner_id\": \"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4\",\n \"probability\": 50,\n \"status\": \"open\",\n \"value\": 123,\n \"visibility\": \"company\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"id": "deal_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"pipeline_id": "pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"stage_id": "stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "private",
"contact_id": "con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"custom_fields": {},
"expected_close_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"lost_justification": "<string>",
"lost_reason": "<string>",
"lost_reason_id": "lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"object": "deal",
"organization": {
"created_at": "2023-11-07T05:31:56Z",
"id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "private",
"custom_fields": {},
"external_id": "<string>",
"object": "organization",
"owner": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"tags": [
{
"id": "tag_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"name": "<string>",
"color": "<string>",
"object": "tag"
}
],
"website": "<string>"
},
"organization_id": "org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"owner": {
"id": "<string>",
"kind": "user",
"name": "<string>",
"object": "owner"
},
"owner_id": "usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"probability": 123,
"score": "cold",
"stage_changed_at": "2023-11-07T05:31:56Z",
"status": "open",
"tags": [
{
"id": "tag_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"name": "<string>",
"color": "<string>",
"object": "tag"
}
],
"value": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Authorizations
A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.
Headers
A unique value (a UUID works) that makes retrying this request safe. A repeat with the same key and body within 24 hours returns the original response instead of acting twice; the same key with a different body is a 409 idempotency_key_reused.
Maximum string length:
255Query Parameters
Comma-separated relationships to inline in the response, e.g. organization. Unexpanded relations are still identified by their *_id field.
Example:
"organization"
Body
application/json
Body for POST /v1/deals.
pipeline_id and stage_id are both required and must belong together —
list GET /v1/pipelines to get a valid pair. At least one of contact_id
or organization_id must be set: a deal with neither is with nobody. A deal
created lost needs a lost_reason_id.
Unique identifier for a pipeline.
Pattern:
^pipe_[0-9a-f]{32}$Example:
"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Unique identifier for a stage.
Pattern:
^stg_[0-9a-f]{32}$Example:
"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Required; a nameless deal is not useful.
Minimum string length:
1Unique identifier for a contact.
Pattern:
^con_[0-9a-f]{32}$Example:
"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Your own id for this record, e.g. its id in your system. Unique per workspace and resource; send null to clear it.
Required string length:
1 - 255Example:
"crm-48213"
Free-text detail on the loss. Same rule as lost_reason_id.
Unique identifier for a lost reason.
Pattern:
^lrsn_[0-9a-f]{32}$Example:
"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Unique identifier for an organization.
Pattern:
^org_[0-9a-f]{32}$Example:
"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Unique identifier for an user.
Pattern:
^usr_[0-9a-f]{32}$Example:
"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Required range:
0 <= x <= 100How warm a deal is.
Available options:
cold, warm, hot Whether a deal is still open, won or lost.
Available options:
open, won, lost Who in the workspace can see a record: only its owner, the owner's team, the team and its sub-teams, or everyone.
Available options:
private, team, team_and_subteams, company Response
Successful Response
A negotiation in a pipeline, with a contact and/or an organization.
Unique identifier for a deal.
Pattern:
^deal_[0-9a-f]{32}$Example:
"deal_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Unique identifier for a pipeline.
Pattern:
^pipe_[0-9a-f]{32}$Example:
"pipe_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Unique identifier for a stage.
Pattern:
^stg_[0-9a-f]{32}$Example:
"stg_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Who in the workspace can see this record. A workspace token sees every record regardless; an OAuth token sees what the person who authorized it can see.
Available options:
private, team, team_and_subteams, company Unique identifier for a contact.
Pattern:
^con_[0-9a-f]{32}$Example:
"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Every custom field defined on deals in this workspace, keyed by field key and typed from its definition. Unset fields are null.
Your own id for this record, when you set one.
Free-text detail on the loss, when status is lost.
Name of the reason, when status is lost.
Unique identifier for a lost reason.
Pattern:
^lrsn_[0-9a-f]{32}$Example:
"lrsn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Allowed value:
"deal"Populated only when organization is in expand.
Show child attributes
Show child attributes
Unique identifier for an organization.
Pattern:
^org_[0-9a-f]{32}$Example:
"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Whoever is responsible for this deal — a teammate or an AI agent. Always populated when the deal has an owner.
Show child attributes
Show child attributes
Unique identifier for an user.
Pattern:
^usr_[0-9a-f]{32}$Example:
"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Close probability override, 0-100. null means the deal inherits its current stage's default — read the stage to see it.
How warm a deal is.
Available options:
cold, warm, hot When the deal last moved between stages.
Whether a deal is still open, won or lost.
Available options:
open, won, lost Show child attributes
Show child attributes
Monetary value. The workspace sets the currency.