curl --request PATCH \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"expectedRevision": 3,
"name": "Acme renewal 2027 - expanded",
"values": {
"budget": 18000000
}
}
'import requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}"
payload = {
"expectedRevision": 3,
"name": "Acme renewal 2027 - expanded",
"values": { "budget": 18000000 }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedRevision: 3,
name: 'Acme renewal 2027 - expanded',
values: {budget: 18000000}
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}', 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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}",
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([
'expectedRevision' => 3,
'name' => 'Acme renewal 2027 - expanded',
'values' => [
'budget' => 18000000
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}"
payload := strings.NewReader("{\n \"expectedRevision\": 3,\n \"name\": \"Acme renewal 2027 - expanded\",\n \"values\": {\n \"budget\": 18000000\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-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.patch("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expectedRevision\": 3,\n \"name\": \"Acme renewal 2027 - expanded\",\n \"values\": {\n \"budget\": 18000000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedRevision\": 3,\n \"name\": \"Acme renewal 2027 - expanded\",\n \"values\": {\n \"budget\": 18000000\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11",
"pipelineId": "5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10",
"pipelineVersion": 3,
"stageId": "stage-new",
"state": "OPEN",
"name": "Acme renewal 2027",
"contact": {
"id": "4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"
},
"source": "API",
"revision": 1,
"createdAt": "2026-11-11T15:00:00.000Z",
"updatedAt": "2026-11-11T15:00:00.000Z",
"values": {
"budget": 15000000,
"closeDate": "2026-12-15"
},
"ownerId": null,
"externalId": "ERP-OPP-981",
"closeReason": {
"id": "reason-price",
"label": "Price too high",
"note": null
},
"closedAt": null
}Update a pipeline record
Change the name or some values of a record, open or closed.
Only the fields sent change: a missing name keeps the name, and the attributes left out of values keep their
value; a null, a blank text or an empty list removes a value. A record always has a name, so a null or blank
name fails like any other invalid field. Every problem found is listed in extra.errors of the 422
BRIDGE_PIPELINE_0311, which is also the answer to a body that changes nothing. A change that leaves the record
as it is writes nothing and answers the record. With expectedRevision, a record changed since you read it fails
with 409 BRIDGE_PIPELINE_0101, whose extra.currentRecord is the record as it is now.
curl --request PATCH \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"expectedRevision": 3,
"name": "Acme renewal 2027 - expanded",
"values": {
"budget": 18000000
}
}
'import requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}"
payload = {
"expectedRevision": 3,
"name": "Acme renewal 2027 - expanded",
"values": { "budget": 18000000 }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedRevision: 3,
name: 'Acme renewal 2027 - expanded',
values: {budget: 18000000}
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}', 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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}",
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([
'expectedRevision' => 3,
'name' => 'Acme renewal 2027 - expanded',
'values' => [
'budget' => 18000000
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}"
payload := strings.NewReader("{\n \"expectedRevision\": 3,\n \"name\": \"Acme renewal 2027 - expanded\",\n \"values\": {\n \"budget\": 18000000\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-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.patch("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expectedRevision\": 3,\n \"name\": \"Acme renewal 2027 - expanded\",\n \"values\": {\n \"budget\": 18000000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records/{recordId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedRevision\": 3,\n \"name\": \"Acme renewal 2027 - expanded\",\n \"values\": {\n \"budget\": 18000000\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11",
"pipelineId": "5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10",
"pipelineVersion": 3,
"stageId": "stage-new",
"state": "OPEN",
"name": "Acme renewal 2027",
"contact": {
"id": "4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"
},
"source": "API",
"revision": 1,
"createdAt": "2026-11-11T15:00:00.000Z",
"updatedAt": "2026-11-11T15:00:00.000Z",
"values": {
"budget": 15000000,
"closeDate": "2026-12-15"
},
"ownerId": null,
"externalId": "ERP-OPP-981",
"closeReason": {
"id": "reason-price",
"label": "Price too high",
"note": null
},
"closedAt": null
}Path Parameters
Body
Request body to change the name or some values of a pipeline record.
The record's revision you last read. When it is no longer the current one, the change fails with 409 BRIDGE_PIPELINE_0101 and the current record in extra.currentRecord. Without it, the change applies to the record as the request reads it, so another change made at the same moment can still fail it with that 409.
x >= 13
Response
Successful Response
A record of a pipeline, such as a sales opportunity of a contact.
Was this page helpful?

