curl --request POST \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"contact": {
"id": "4e362e2b-67b2-4a7e-a9df-e9ecf9141be8",
"phone": "+573001234567",
"email": "john.doe@example.com"
},
"pipelineId": "5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10",
"stageId": "stage-new",
"name": "Acme renewal 2027",
"externalId": "ERP-OPP-981",
"values": {
"budget": 15000000,
"closeDate": "2026-12-15",
"segment": "Retail"
}
}
'import requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records"
payload = {
"contact": {
"id": "4e362e2b-67b2-4a7e-a9df-e9ecf9141be8",
"phone": "+573001234567",
"email": "john.doe@example.com"
},
"pipelineId": "5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10",
"stageId": "stage-new",
"name": "Acme renewal 2027",
"externalId": "ERP-OPP-981",
"values": {
"budget": 15000000,
"closeDate": "2026-12-15",
"segment": "Retail"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contact: {
id: '4e362e2b-67b2-4a7e-a9df-e9ecf9141be8',
phone: '+573001234567',
email: 'john.doe@example.com'
},
pipelineId: '5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10',
stageId: 'stage-new',
name: 'Acme renewal 2027',
externalId: 'ERP-OPP-981',
values: {budget: 15000000, closeDate: '2026-12-15', segment: 'Retail'}
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records', 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",
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([
'contact' => [
'id' => '4e362e2b-67b2-4a7e-a9df-e9ecf9141be8',
'phone' => '+573001234567',
'email' => 'john.doe@example.com'
],
'pipelineId' => '5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10',
'stageId' => 'stage-new',
'name' => 'Acme renewal 2027',
'externalId' => 'ERP-OPP-981',
'values' => [
'budget' => 15000000,
'closeDate' => '2026-12-15',
'segment' => 'Retail'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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"
payload := strings.NewReader("{\n \"contact\": {\n \"id\": \"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8\",\n \"phone\": \"+573001234567\",\n \"email\": \"john.doe@example.com\"\n },\n \"pipelineId\": \"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10\",\n \"stageId\": \"stage-new\",\n \"name\": \"Acme renewal 2027\",\n \"externalId\": \"ERP-OPP-981\",\n \"values\": {\n \"budget\": 15000000,\n \"closeDate\": \"2026-12-15\",\n \"segment\": \"Retail\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"id\": \"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8\",\n \"phone\": \"+573001234567\",\n \"email\": \"john.doe@example.com\"\n },\n \"pipelineId\": \"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10\",\n \"stageId\": \"stage-new\",\n \"name\": \"Acme renewal 2027\",\n \"externalId\": \"ERP-OPP-981\",\n \"values\": {\n \"budget\": 15000000,\n \"closeDate\": \"2026-12-15\",\n \"segment\": \"Retail\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"id\": \"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8\",\n \"phone\": \"+573001234567\",\n \"email\": \"john.doe@example.com\"\n },\n \"pipelineId\": \"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10\",\n \"stageId\": \"stage-new\",\n \"name\": \"Acme renewal 2027\",\n \"externalId\": \"ERP-OPP-981\",\n \"values\": {\n \"budget\": 15000000,\n \"closeDate\": \"2026-12-15\",\n \"segment\": \"Retail\"\n }\n}"
response = http.request(request)
puts response.read_bodyCreate a pipeline record
Create a record of a contact in a pipeline, such as a sales opportunity.
The contact is given by exactly one of id, phone or email and must exist: it is never created (404
BRIDGE_EXTERNAL_0001). pipelineId defaults to the workspace’s default pipeline and stageId to the
pipeline’s initial stage. A missing or blank name defaults to the contact’s full name, then its cellphone,
then its email. Only open stages are accepted, and only RECORD-scope attributes of the pipeline’s current
version in values (a null, a blank text or an empty list is left out); every problem found is listed in extra.errors of the 422
BRIDGE_PIPELINE_0311. When the stage the record starts in requires a complete contact (first name, last name,
cellphone and every required custom attribute of the workspace), an incomplete one fails with 422
BRIDGE_PIPELINE_0305, whose extra.missing names what it lacks. A second record with the same externalId
in the pipeline fails with 409 BRIDGE_PIPELINE_0003, whose extra.recordId is the existing record.
Idempotency-Key is required. Retrying with the same key and body answers 201 with the first record and
Idempotent-Replayed: true. The same key with a different body fails with 422 BRIDGE_PIPELINE_0402, and
while the first request is still running with 409 BRIDGE_PIPELINE_0401. When the request fails, the key is
freed and can be retried. If the first request was cut off before it finished, its key keeps answering 409
BRIDGE_PIPELINE_0401 for up to 24 hours: retry with a new key, and send externalId so that a retry never
creates a second record.
curl --request POST \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"contact": {
"id": "4e362e2b-67b2-4a7e-a9df-e9ecf9141be8",
"phone": "+573001234567",
"email": "john.doe@example.com"
},
"pipelineId": "5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10",
"stageId": "stage-new",
"name": "Acme renewal 2027",
"externalId": "ERP-OPP-981",
"values": {
"budget": 15000000,
"closeDate": "2026-12-15",
"segment": "Retail"
}
}
'import requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records"
payload = {
"contact": {
"id": "4e362e2b-67b2-4a7e-a9df-e9ecf9141be8",
"phone": "+573001234567",
"email": "john.doe@example.com"
},
"pipelineId": "5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10",
"stageId": "stage-new",
"name": "Acme renewal 2027",
"externalId": "ERP-OPP-981",
"values": {
"budget": 15000000,
"closeDate": "2026-12-15",
"segment": "Retail"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contact: {
id: '4e362e2b-67b2-4a7e-a9df-e9ecf9141be8',
phone: '+573001234567',
email: 'john.doe@example.com'
},
pipelineId: '5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10',
stageId: 'stage-new',
name: 'Acme renewal 2027',
externalId: 'ERP-OPP-981',
values: {budget: 15000000, closeDate: '2026-12-15', segment: 'Retail'}
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records', 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",
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([
'contact' => [
'id' => '4e362e2b-67b2-4a7e-a9df-e9ecf9141be8',
'phone' => '+573001234567',
'email' => 'john.doe@example.com'
],
'pipelineId' => '5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10',
'stageId' => 'stage-new',
'name' => 'Acme renewal 2027',
'externalId' => 'ERP-OPP-981',
'values' => [
'budget' => 15000000,
'closeDate' => '2026-12-15',
'segment' => 'Retail'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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"
payload := strings.NewReader("{\n \"contact\": {\n \"id\": \"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8\",\n \"phone\": \"+573001234567\",\n \"email\": \"john.doe@example.com\"\n },\n \"pipelineId\": \"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10\",\n \"stageId\": \"stage-new\",\n \"name\": \"Acme renewal 2027\",\n \"externalId\": \"ERP-OPP-981\",\n \"values\": {\n \"budget\": 15000000,\n \"closeDate\": \"2026-12-15\",\n \"segment\": \"Retail\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"id\": \"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8\",\n \"phone\": \"+573001234567\",\n \"email\": \"john.doe@example.com\"\n },\n \"pipelineId\": \"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10\",\n \"stageId\": \"stage-new\",\n \"name\": \"Acme renewal 2027\",\n \"externalId\": \"ERP-OPP-981\",\n \"values\": {\n \"budget\": 15000000,\n \"closeDate\": \"2026-12-15\",\n \"segment\": \"Retail\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"id\": \"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8\",\n \"phone\": \"+573001234567\",\n \"email\": \"john.doe@example.com\"\n },\n \"pipelineId\": \"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10\",\n \"stageId\": \"stage-new\",\n \"name\": \"Acme renewal 2027\",\n \"externalId\": \"ERP-OPP-981\",\n \"values\": {\n \"budget\": 15000000,\n \"closeDate\": \"2026-12-15\",\n \"segment\": \"Retail\"\n }\n}"
response = http.request(request)
puts response.read_bodyHeaders
Path Parameters
Body
Request body to create a pipeline record.
Values of the record's attributes, keyed by attribute id. Only RECORD-scope attributes of the pipeline's current version are accepted, each checked against its type (TEXT up to 2000 characters); a null value, a blank text and an empty list are left out.
{ "budget": 15000000, "closeDate": "2026-12-15", "segment": "Retail" }
Response
The record was created, or a previous request with the same key created it.
A record of a pipeline, such as a sales opportunity of a contact.
Was this page helpful?

