Update a pipeline
curl --request PATCH \
--url https://api.vendaze.com/v1/pipelines/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Renamed Pipeline",
"stages": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Prospecting",
"type": "open",
"probability": 15
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Proposal Sent",
"type": "open",
"probability": 50
},
{
"name": "New: Pilot",
"type": "open",
"probability": 75
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Closed Won",
"type": "win",
"probability": 100
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Closed Lost",
"type": "lost",
"probability": 0
}
]
}
'import requests
url = "https://api.vendaze.com/v1/pipelines/{id}"
payload = {
"name": "Renamed Pipeline",
"stages": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Prospecting",
"type": "open",
"probability": 15
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Proposal Sent",
"type": "open",
"probability": 50
},
{
"name": "New: Pilot",
"type": "open",
"probability": 75
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Closed Won",
"type": "win",
"probability": 100
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Closed Lost",
"type": "lost",
"probability": 0
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Renamed Pipeline',
stages: [
{
id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
name: 'Prospecting',
type: 'open',
probability: 15
},
{
id: 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
name: 'Proposal Sent',
type: 'open',
probability: 50
},
{name: 'New: Pilot', type: 'open', probability: 75},
{
id: 'c3d4e5f6-a7b8-9012-cdef-123456789012',
name: 'Closed Won',
type: 'win',
probability: 100
},
{
id: 'd4e5f6a7-b8c9-0123-defa-234567890123',
name: 'Closed Lost',
type: 'lost',
probability: 0
}
]
})
};
fetch('https://api.vendaze.com/v1/pipelines/{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.vendaze.com/v1/pipelines/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Renamed Pipeline',
'stages' => [
[
'id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
'name' => 'Prospecting',
'type' => 'open',
'probability' => 15
],
[
'id' => 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
'name' => 'Proposal Sent',
'type' => 'open',
'probability' => 50
],
[
'name' => 'New: Pilot',
'type' => 'open',
'probability' => 75
],
[
'id' => 'c3d4e5f6-a7b8-9012-cdef-123456789012',
'name' => 'Closed Won',
'type' => 'win',
'probability' => 100
],
[
'id' => 'd4e5f6a7-b8c9-0123-defa-234567890123',
'name' => 'Closed Lost',
'type' => 'lost',
'probability' => 0
]
]
]),
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.vendaze.com/v1/pipelines/{id}"
payload := strings.NewReader("{\n \"name\": \"Renamed Pipeline\",\n \"stages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Prospecting\",\n \"type\": \"open\",\n \"probability\": 15\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"Proposal Sent\",\n \"type\": \"open\",\n \"probability\": 50\n },\n {\n \"name\": \"New: Pilot\",\n \"type\": \"open\",\n \"probability\": 75\n },\n {\n \"id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Closed Won\",\n \"type\": \"win\",\n \"probability\": 100\n },\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Closed Lost\",\n \"type\": \"lost\",\n \"probability\": 0\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.vendaze.com/v1/pipelines/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Renamed Pipeline\",\n \"stages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Prospecting\",\n \"type\": \"open\",\n \"probability\": 15\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"Proposal Sent\",\n \"type\": \"open\",\n \"probability\": 50\n },\n {\n \"name\": \"New: Pilot\",\n \"type\": \"open\",\n \"probability\": 75\n },\n {\n \"id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Closed Won\",\n \"type\": \"win\",\n \"probability\": 100\n },\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Closed Lost\",\n \"type\": \"lost\",\n \"probability\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vendaze.com/v1/pipelines/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Renamed Pipeline\",\n \"stages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Prospecting\",\n \"type\": \"open\",\n \"probability\": 15\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"Proposal Sent\",\n \"type\": \"open\",\n \"probability\": 50\n },\n {\n \"name\": \"New: Pilot\",\n \"type\": \"open\",\n \"probability\": 75\n },\n {\n \"id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Closed Won\",\n \"type\": \"win\",\n \"probability\": 100\n },\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Closed Lost\",\n \"type\": \"lost\",\n \"probability\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "New Business",
"created_at": "2023-11-07T05:31:56Z",
"stages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Proposal",
"type": "open",
"probability": 40,
"created_at": "2023-11-07T05:31:56Z"
}
]
}
}{
"error": {
"code": "bad_request",
"message": "No fields provided for update.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "insufficient_scope",
"message": "This endpoint requires the 'webhooks:read' scope.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "not_found",
"message": "Webhook not found.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "validation_error",
"message": "Validation failed.",
"fields": {
"url": "url must use HTTPS.",
"events": "At least one event is required."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Pipelines
Update a pipeline
Updates a pipeline. Only the fields sent are modified.
Required scope
Required scope
deals:write
PATCH
/
v1
/
pipelines
/
{id}
Update a pipeline
curl --request PATCH \
--url https://api.vendaze.com/v1/pipelines/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Renamed Pipeline",
"stages": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Prospecting",
"type": "open",
"probability": 15
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Proposal Sent",
"type": "open",
"probability": 50
},
{
"name": "New: Pilot",
"type": "open",
"probability": 75
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Closed Won",
"type": "win",
"probability": 100
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Closed Lost",
"type": "lost",
"probability": 0
}
]
}
'import requests
url = "https://api.vendaze.com/v1/pipelines/{id}"
payload = {
"name": "Renamed Pipeline",
"stages": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Prospecting",
"type": "open",
"probability": 15
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Proposal Sent",
"type": "open",
"probability": 50
},
{
"name": "New: Pilot",
"type": "open",
"probability": 75
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Closed Won",
"type": "win",
"probability": 100
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Closed Lost",
"type": "lost",
"probability": 0
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Renamed Pipeline',
stages: [
{
id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
name: 'Prospecting',
type: 'open',
probability: 15
},
{
id: 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
name: 'Proposal Sent',
type: 'open',
probability: 50
},
{name: 'New: Pilot', type: 'open', probability: 75},
{
id: 'c3d4e5f6-a7b8-9012-cdef-123456789012',
name: 'Closed Won',
type: 'win',
probability: 100
},
{
id: 'd4e5f6a7-b8c9-0123-defa-234567890123',
name: 'Closed Lost',
type: 'lost',
probability: 0
}
]
})
};
fetch('https://api.vendaze.com/v1/pipelines/{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.vendaze.com/v1/pipelines/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Renamed Pipeline',
'stages' => [
[
'id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
'name' => 'Prospecting',
'type' => 'open',
'probability' => 15
],
[
'id' => 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
'name' => 'Proposal Sent',
'type' => 'open',
'probability' => 50
],
[
'name' => 'New: Pilot',
'type' => 'open',
'probability' => 75
],
[
'id' => 'c3d4e5f6-a7b8-9012-cdef-123456789012',
'name' => 'Closed Won',
'type' => 'win',
'probability' => 100
],
[
'id' => 'd4e5f6a7-b8c9-0123-defa-234567890123',
'name' => 'Closed Lost',
'type' => 'lost',
'probability' => 0
]
]
]),
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.vendaze.com/v1/pipelines/{id}"
payload := strings.NewReader("{\n \"name\": \"Renamed Pipeline\",\n \"stages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Prospecting\",\n \"type\": \"open\",\n \"probability\": 15\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"Proposal Sent\",\n \"type\": \"open\",\n \"probability\": 50\n },\n {\n \"name\": \"New: Pilot\",\n \"type\": \"open\",\n \"probability\": 75\n },\n {\n \"id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Closed Won\",\n \"type\": \"win\",\n \"probability\": 100\n },\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Closed Lost\",\n \"type\": \"lost\",\n \"probability\": 0\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.vendaze.com/v1/pipelines/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Renamed Pipeline\",\n \"stages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Prospecting\",\n \"type\": \"open\",\n \"probability\": 15\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"Proposal Sent\",\n \"type\": \"open\",\n \"probability\": 50\n },\n {\n \"name\": \"New: Pilot\",\n \"type\": \"open\",\n \"probability\": 75\n },\n {\n \"id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Closed Won\",\n \"type\": \"win\",\n \"probability\": 100\n },\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Closed Lost\",\n \"type\": \"lost\",\n \"probability\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vendaze.com/v1/pipelines/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Renamed Pipeline\",\n \"stages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Prospecting\",\n \"type\": \"open\",\n \"probability\": 15\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"Proposal Sent\",\n \"type\": \"open\",\n \"probability\": 50\n },\n {\n \"name\": \"New: Pilot\",\n \"type\": \"open\",\n \"probability\": 75\n },\n {\n \"id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Closed Won\",\n \"type\": \"win\",\n \"probability\": 100\n },\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Closed Lost\",\n \"type\": \"lost\",\n \"probability\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "New Business",
"created_at": "2023-11-07T05:31:56Z",
"stages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Proposal",
"type": "open",
"probability": 40,
"created_at": "2023-11-07T05:31:56Z"
}
]
}
}{
"error": {
"code": "bad_request",
"message": "No fields provided for update.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "insufficient_scope",
"message": "This endpoint requires the 'webhooks:read' scope.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "not_found",
"message": "Webhook not found.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "validation_error",
"message": "Validation failed.",
"fields": {
"url": "url must use HTTPS.",
"events": "At least one event is required."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Authorizations
OAuth 2.1 access token.
Path Parameters
UUID of the resource.
Body
application/json
Response
Pipeline updated successfully.
Show child attributes
Show child attributes