Update Pipeline
curl --request PUT \
--url https://api.decodahealth.com/opportunity/pipeline/{pipeline_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"description": "<string>",
"isActive": true,
"stages": [
{
"id": "<string>",
"name": "<string>",
"stageNumber": 123,
"color": "<string>",
"staleAfterDays": 123,
"isTerminalWon": true,
"isTerminalLost": true,
"autoConvert": true,
"automationSequence": {
"entryStepId": "<string>",
"steps": [
{
"displayOrder": 1,
"id": "<string>",
"clientKey": "<string>",
"config": {},
"isActive": true
}
],
"id": "<string>",
"name": "<string>",
"description": "<string>",
"isActive": false,
"pipelineExitPolicy": "CANCEL_ON_EXIT",
"transitions": [
{
"fromStepId": "<string>",
"toStepId": "<string>",
"id": "<string>",
"condition": {
"kind": "PREVIOUS_EMAIL_EVENT"
},
"isDefault": false,
"label": "<string>"
}
]
}
}
]
}
'import requests
url = "https://api.decodahealth.com/opportunity/pipeline/{pipeline_id}"
payload = {
"name": "<string>",
"description": "<string>",
"isActive": True,
"stages": [
{
"id": "<string>",
"name": "<string>",
"stageNumber": 123,
"color": "<string>",
"staleAfterDays": 123,
"isTerminalWon": True,
"isTerminalLost": True,
"autoConvert": True,
"automationSequence": {
"entryStepId": "<string>",
"steps": [
{
"displayOrder": 1,
"id": "<string>",
"clientKey": "<string>",
"config": {},
"isActive": True
}
],
"id": "<string>",
"name": "<string>",
"description": "<string>",
"isActive": False,
"pipelineExitPolicy": "CANCEL_ON_EXIT",
"transitions": [
{
"fromStepId": "<string>",
"toStepId": "<string>",
"id": "<string>",
"condition": { "kind": "PREVIOUS_EMAIL_EVENT" },
"isDefault": False,
"label": "<string>"
}
]
}
}
]
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
isActive: true,
stages: [
{
id: '<string>',
name: '<string>',
stageNumber: 123,
color: '<string>',
staleAfterDays: 123,
isTerminalWon: true,
isTerminalLost: true,
autoConvert: true,
automationSequence: {
entryStepId: '<string>',
steps: [
{
displayOrder: 1,
id: '<string>',
clientKey: '<string>',
config: {},
isActive: true
}
],
id: '<string>',
name: '<string>',
description: '<string>',
isActive: false,
pipelineExitPolicy: 'CANCEL_ON_EXIT',
transitions: [
{
fromStepId: '<string>',
toStepId: '<string>',
id: '<string>',
condition: {kind: 'PREVIOUS_EMAIL_EVENT'},
isDefault: false,
label: '<string>'
}
]
}
}
]
})
};
fetch('https://api.decodahealth.com/opportunity/pipeline/{pipeline_id}', 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.decodahealth.com/opportunity/pipeline/{pipeline_id}",
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>',
'description' => '<string>',
'isActive' => true,
'stages' => [
[
'id' => '<string>',
'name' => '<string>',
'stageNumber' => 123,
'color' => '<string>',
'staleAfterDays' => 123,
'isTerminalWon' => true,
'isTerminalLost' => true,
'autoConvert' => true,
'automationSequence' => [
'entryStepId' => '<string>',
'steps' => [
[
'displayOrder' => 1,
'id' => '<string>',
'clientKey' => '<string>',
'config' => [
],
'isActive' => true
]
],
'id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'isActive' => false,
'pipelineExitPolicy' => 'CANCEL_ON_EXIT',
'transitions' => [
[
'fromStepId' => '<string>',
'toStepId' => '<string>',
'id' => '<string>',
'condition' => [
'kind' => 'PREVIOUS_EMAIL_EVENT'
],
'isDefault' => false,
'label' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/opportunity/pipeline/{pipeline_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": true,\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"stageNumber\": 123,\n \"color\": \"<string>\",\n \"staleAfterDays\": 123,\n \"isTerminalWon\": true,\n \"isTerminalLost\": true,\n \"autoConvert\": true,\n \"automationSequence\": {\n \"entryStepId\": \"<string>\",\n \"steps\": [\n {\n \"displayOrder\": 1,\n \"id\": \"<string>\",\n \"clientKey\": \"<string>\",\n \"config\": {},\n \"isActive\": true\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": false,\n \"pipelineExitPolicy\": \"CANCEL_ON_EXIT\",\n \"transitions\": [\n {\n \"fromStepId\": \"<string>\",\n \"toStepId\": \"<string>\",\n \"id\": \"<string>\",\n \"condition\": {\n \"kind\": \"PREVIOUS_EMAIL_EVENT\"\n },\n \"isDefault\": false,\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-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.decodahealth.com/opportunity/pipeline/{pipeline_id}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": true,\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"stageNumber\": 123,\n \"color\": \"<string>\",\n \"staleAfterDays\": 123,\n \"isTerminalWon\": true,\n \"isTerminalLost\": true,\n \"autoConvert\": true,\n \"automationSequence\": {\n \"entryStepId\": \"<string>\",\n \"steps\": [\n {\n \"displayOrder\": 1,\n \"id\": \"<string>\",\n \"clientKey\": \"<string>\",\n \"config\": {},\n \"isActive\": true\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": false,\n \"pipelineExitPolicy\": \"CANCEL_ON_EXIT\",\n \"transitions\": [\n {\n \"fromStepId\": \"<string>\",\n \"toStepId\": \"<string>\",\n \"id\": \"<string>\",\n \"condition\": {\n \"kind\": \"PREVIOUS_EMAIL_EVENT\"\n },\n \"isDefault\": false,\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/opportunity/pipeline/{pipeline_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": true,\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"stageNumber\": 123,\n \"color\": \"<string>\",\n \"staleAfterDays\": 123,\n \"isTerminalWon\": true,\n \"isTerminalLost\": true,\n \"autoConvert\": true,\n \"automationSequence\": {\n \"entryStepId\": \"<string>\",\n \"steps\": [\n {\n \"displayOrder\": 1,\n \"id\": \"<string>\",\n \"clientKey\": \"<string>\",\n \"config\": {},\n \"isActive\": true\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": false,\n \"pipelineExitPolicy\": \"CANCEL_ON_EXIT\",\n \"transitions\": [\n {\n \"fromStepId\": \"<string>\",\n \"toStepId\": \"<string>\",\n \"id\": \"<string>\",\n \"condition\": {\n \"kind\": \"PREVIOUS_EMAIL_EVENT\"\n },\n \"isDefault\": false,\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"locationId": "<string>",
"description": "<string>",
"isActive": true,
"stages": [
{
"id": "<string>",
"pipelineId": "<string>",
"name": "<string>",
"stageNumber": 123,
"color": "<string>",
"kind": "WORKING",
"staleAfterDays": 123,
"isTerminalWon": false,
"isTerminalLost": false,
"autoConvert": false
}
],
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Pipelines
Update Pipeline
Update a pipeline’s fields and reconcile its stages (add, update, or remove stages and their actions).
PUT
/
opportunity
/
pipeline
/
{pipeline_id}
Update Pipeline
curl --request PUT \
--url https://api.decodahealth.com/opportunity/pipeline/{pipeline_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"description": "<string>",
"isActive": true,
"stages": [
{
"id": "<string>",
"name": "<string>",
"stageNumber": 123,
"color": "<string>",
"staleAfterDays": 123,
"isTerminalWon": true,
"isTerminalLost": true,
"autoConvert": true,
"automationSequence": {
"entryStepId": "<string>",
"steps": [
{
"displayOrder": 1,
"id": "<string>",
"clientKey": "<string>",
"config": {},
"isActive": true
}
],
"id": "<string>",
"name": "<string>",
"description": "<string>",
"isActive": false,
"pipelineExitPolicy": "CANCEL_ON_EXIT",
"transitions": [
{
"fromStepId": "<string>",
"toStepId": "<string>",
"id": "<string>",
"condition": {
"kind": "PREVIOUS_EMAIL_EVENT"
},
"isDefault": false,
"label": "<string>"
}
]
}
}
]
}
'import requests
url = "https://api.decodahealth.com/opportunity/pipeline/{pipeline_id}"
payload = {
"name": "<string>",
"description": "<string>",
"isActive": True,
"stages": [
{
"id": "<string>",
"name": "<string>",
"stageNumber": 123,
"color": "<string>",
"staleAfterDays": 123,
"isTerminalWon": True,
"isTerminalLost": True,
"autoConvert": True,
"automationSequence": {
"entryStepId": "<string>",
"steps": [
{
"displayOrder": 1,
"id": "<string>",
"clientKey": "<string>",
"config": {},
"isActive": True
}
],
"id": "<string>",
"name": "<string>",
"description": "<string>",
"isActive": False,
"pipelineExitPolicy": "CANCEL_ON_EXIT",
"transitions": [
{
"fromStepId": "<string>",
"toStepId": "<string>",
"id": "<string>",
"condition": { "kind": "PREVIOUS_EMAIL_EVENT" },
"isDefault": False,
"label": "<string>"
}
]
}
}
]
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
isActive: true,
stages: [
{
id: '<string>',
name: '<string>',
stageNumber: 123,
color: '<string>',
staleAfterDays: 123,
isTerminalWon: true,
isTerminalLost: true,
autoConvert: true,
automationSequence: {
entryStepId: '<string>',
steps: [
{
displayOrder: 1,
id: '<string>',
clientKey: '<string>',
config: {},
isActive: true
}
],
id: '<string>',
name: '<string>',
description: '<string>',
isActive: false,
pipelineExitPolicy: 'CANCEL_ON_EXIT',
transitions: [
{
fromStepId: '<string>',
toStepId: '<string>',
id: '<string>',
condition: {kind: 'PREVIOUS_EMAIL_EVENT'},
isDefault: false,
label: '<string>'
}
]
}
}
]
})
};
fetch('https://api.decodahealth.com/opportunity/pipeline/{pipeline_id}', 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.decodahealth.com/opportunity/pipeline/{pipeline_id}",
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>',
'description' => '<string>',
'isActive' => true,
'stages' => [
[
'id' => '<string>',
'name' => '<string>',
'stageNumber' => 123,
'color' => '<string>',
'staleAfterDays' => 123,
'isTerminalWon' => true,
'isTerminalLost' => true,
'autoConvert' => true,
'automationSequence' => [
'entryStepId' => '<string>',
'steps' => [
[
'displayOrder' => 1,
'id' => '<string>',
'clientKey' => '<string>',
'config' => [
],
'isActive' => true
]
],
'id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'isActive' => false,
'pipelineExitPolicy' => 'CANCEL_ON_EXIT',
'transitions' => [
[
'fromStepId' => '<string>',
'toStepId' => '<string>',
'id' => '<string>',
'condition' => [
'kind' => 'PREVIOUS_EMAIL_EVENT'
],
'isDefault' => false,
'label' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/opportunity/pipeline/{pipeline_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": true,\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"stageNumber\": 123,\n \"color\": \"<string>\",\n \"staleAfterDays\": 123,\n \"isTerminalWon\": true,\n \"isTerminalLost\": true,\n \"autoConvert\": true,\n \"automationSequence\": {\n \"entryStepId\": \"<string>\",\n \"steps\": [\n {\n \"displayOrder\": 1,\n \"id\": \"<string>\",\n \"clientKey\": \"<string>\",\n \"config\": {},\n \"isActive\": true\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": false,\n \"pipelineExitPolicy\": \"CANCEL_ON_EXIT\",\n \"transitions\": [\n {\n \"fromStepId\": \"<string>\",\n \"toStepId\": \"<string>\",\n \"id\": \"<string>\",\n \"condition\": {\n \"kind\": \"PREVIOUS_EMAIL_EVENT\"\n },\n \"isDefault\": false,\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-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.decodahealth.com/opportunity/pipeline/{pipeline_id}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": true,\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"stageNumber\": 123,\n \"color\": \"<string>\",\n \"staleAfterDays\": 123,\n \"isTerminalWon\": true,\n \"isTerminalLost\": true,\n \"autoConvert\": true,\n \"automationSequence\": {\n \"entryStepId\": \"<string>\",\n \"steps\": [\n {\n \"displayOrder\": 1,\n \"id\": \"<string>\",\n \"clientKey\": \"<string>\",\n \"config\": {},\n \"isActive\": true\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": false,\n \"pipelineExitPolicy\": \"CANCEL_ON_EXIT\",\n \"transitions\": [\n {\n \"fromStepId\": \"<string>\",\n \"toStepId\": \"<string>\",\n \"id\": \"<string>\",\n \"condition\": {\n \"kind\": \"PREVIOUS_EMAIL_EVENT\"\n },\n \"isDefault\": false,\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/opportunity/pipeline/{pipeline_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": true,\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"stageNumber\": 123,\n \"color\": \"<string>\",\n \"staleAfterDays\": 123,\n \"isTerminalWon\": true,\n \"isTerminalLost\": true,\n \"autoConvert\": true,\n \"automationSequence\": {\n \"entryStepId\": \"<string>\",\n \"steps\": [\n {\n \"displayOrder\": 1,\n \"id\": \"<string>\",\n \"clientKey\": \"<string>\",\n \"config\": {},\n \"isActive\": true\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isActive\": false,\n \"pipelineExitPolicy\": \"CANCEL_ON_EXIT\",\n \"transitions\": [\n {\n \"fromStepId\": \"<string>\",\n \"toStepId\": \"<string>\",\n \"id\": \"<string>\",\n \"condition\": {\n \"kind\": \"PREVIOUS_EMAIL_EVENT\"\n },\n \"isDefault\": false,\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"locationId": "<string>",
"description": "<string>",
"isActive": true,
"stages": [
{
"id": "<string>",
"pipelineId": "<string>",
"name": "<string>",
"stageNumber": 123,
"color": "<string>",
"kind": "WORKING",
"staleAfterDays": 123,
"isTerminalWon": false,
"isTerminalLost": false,
"autoConvert": false
}
],
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json

