HueChat Sales
Save a Sales pipeline definition atomically
Workspace administrators with account:write only. Requires the current definition version; stale saves return 409. Occupied stages cannot be deleted or change outcome. Records history and a transactional outbox event.
PUT
/
api
/
v2
/
accounts
/
{accountId}
/
sales
/
pipelines
/
{pipelineId}
/
definition
Save a Sales pipeline definition atomically
curl --request PUT \
--url https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"stages": [
{
"color": "<string>",
"deal_count": 123,
"id": "<string>",
"is_lost": true,
"is_won": true,
"name": "<string>",
"probability": 123,
"rule": {
"exit_required_fields": [
"<string>"
],
"forecast_category": "<string>",
"guidance": "<string>",
"required_fields": [
"<string>"
],
"stale_after_days": 123
}
}
],
"version": "<string>"
}
'import requests
url = "https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition"
payload = {
"name": "<string>",
"stages": [
{
"color": "<string>",
"deal_count": 123,
"id": "<string>",
"is_lost": True,
"is_won": True,
"name": "<string>",
"probability": 123,
"rule": {
"exit_required_fields": ["<string>"],
"forecast_category": "<string>",
"guidance": "<string>",
"required_fields": ["<string>"],
"stale_after_days": 123
}
}
],
"version": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
stages: [
{
color: '<string>',
deal_count: 123,
id: '<string>',
is_lost: true,
is_won: true,
name: '<string>',
probability: 123,
rule: {
exit_required_fields: ['<string>'],
forecast_category: '<string>',
guidance: '<string>',
required_fields: ['<string>'],
stale_after_days: 123
}
}
],
version: '<string>'
})
};
fetch('https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition', 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://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition",
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([
'name' => '<string>',
'stages' => [
[
'color' => '<string>',
'deal_count' => 123,
'id' => '<string>',
'is_lost' => true,
'is_won' => true,
'name' => '<string>',
'probability' => 123,
'rule' => [
'exit_required_fields' => [
'<string>'
],
'forecast_category' => '<string>',
'guidance' => '<string>',
'required_fields' => [
'<string>'
],
'stale_after_days' => 123
]
]
],
'version' => '<string>'
]),
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://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"deal_count\": 123,\n \"id\": \"<string>\",\n \"is_lost\": true,\n \"is_won\": true,\n \"name\": \"<string>\",\n \"probability\": 123,\n \"rule\": {\n \"exit_required_fields\": [\n \"<string>\"\n ],\n \"forecast_category\": \"<string>\",\n \"guidance\": \"<string>\",\n \"required_fields\": [\n \"<string>\"\n ],\n \"stale_after_days\": 123\n }\n }\n ],\n \"version\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"deal_count\": 123,\n \"id\": \"<string>\",\n \"is_lost\": true,\n \"is_won\": true,\n \"name\": \"<string>\",\n \"probability\": 123,\n \"rule\": {\n \"exit_required_fields\": [\n \"<string>\"\n ],\n \"forecast_category\": \"<string>\",\n \"guidance\": \"<string>\",\n \"required_fields\": [\n \"<string>\"\n ],\n \"stale_after_days\": 123\n }\n }\n ],\n \"version\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"deal_count\": 123,\n \"id\": \"<string>\",\n \"is_lost\": true,\n \"is_won\": true,\n \"name\": \"<string>\",\n \"probability\": 123,\n \"rule\": {\n \"exit_required_fields\": [\n \"<string>\"\n ],\n \"forecast_category\": \"<string>\",\n \"guidance\": \"<string>\",\n \"required_fields\": [\n \"<string>\"\n ],\n \"stale_after_days\": 123\n }\n }\n ],\n \"version\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{}{}{}Authorizations
Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.
Body
application/json
Definition from the editor
Response
OK
The response is of type object.
⌘I
Save a Sales pipeline definition atomically
curl --request PUT \
--url https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"stages": [
{
"color": "<string>",
"deal_count": 123,
"id": "<string>",
"is_lost": true,
"is_won": true,
"name": "<string>",
"probability": 123,
"rule": {
"exit_required_fields": [
"<string>"
],
"forecast_category": "<string>",
"guidance": "<string>",
"required_fields": [
"<string>"
],
"stale_after_days": 123
}
}
],
"version": "<string>"
}
'import requests
url = "https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition"
payload = {
"name": "<string>",
"stages": [
{
"color": "<string>",
"deal_count": 123,
"id": "<string>",
"is_lost": True,
"is_won": True,
"name": "<string>",
"probability": 123,
"rule": {
"exit_required_fields": ["<string>"],
"forecast_category": "<string>",
"guidance": "<string>",
"required_fields": ["<string>"],
"stale_after_days": 123
}
}
],
"version": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
stages: [
{
color: '<string>',
deal_count: 123,
id: '<string>',
is_lost: true,
is_won: true,
name: '<string>',
probability: 123,
rule: {
exit_required_fields: ['<string>'],
forecast_category: '<string>',
guidance: '<string>',
required_fields: ['<string>'],
stale_after_days: 123
}
}
],
version: '<string>'
})
};
fetch('https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition', 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://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition",
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([
'name' => '<string>',
'stages' => [
[
'color' => '<string>',
'deal_count' => 123,
'id' => '<string>',
'is_lost' => true,
'is_won' => true,
'name' => '<string>',
'probability' => 123,
'rule' => [
'exit_required_fields' => [
'<string>'
],
'forecast_category' => '<string>',
'guidance' => '<string>',
'required_fields' => [
'<string>'
],
'stale_after_days' => 123
]
]
],
'version' => '<string>'
]),
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://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"deal_count\": 123,\n \"id\": \"<string>\",\n \"is_lost\": true,\n \"is_won\": true,\n \"name\": \"<string>\",\n \"probability\": 123,\n \"rule\": {\n \"exit_required_fields\": [\n \"<string>\"\n ],\n \"forecast_category\": \"<string>\",\n \"guidance\": \"<string>\",\n \"required_fields\": [\n \"<string>\"\n ],\n \"stale_after_days\": 123\n }\n }\n ],\n \"version\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"deal_count\": 123,\n \"id\": \"<string>\",\n \"is_lost\": true,\n \"is_won\": true,\n \"name\": \"<string>\",\n \"probability\": 123,\n \"rule\": {\n \"exit_required_fields\": [\n \"<string>\"\n ],\n \"forecast_category\": \"<string>\",\n \"guidance\": \"<string>\",\n \"required_fields\": [\n \"<string>\"\n ],\n \"stale_after_days\": 123\n }\n }\n ],\n \"version\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.huechat.ai/api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"stages\": [\n {\n \"color\": \"<string>\",\n \"deal_count\": 123,\n \"id\": \"<string>\",\n \"is_lost\": true,\n \"is_won\": true,\n \"name\": \"<string>\",\n \"probability\": 123,\n \"rule\": {\n \"exit_required_fields\": [\n \"<string>\"\n ],\n \"forecast_category\": \"<string>\",\n \"guidance\": \"<string>\",\n \"required_fields\": [\n \"<string>\"\n ],\n \"stale_after_days\": 123\n }\n }\n ],\n \"version\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{}{}{}
