Editing Deal
Edit the fields of a pipeline deal. You can send either a single object or an array of objects.
PATCH
/api/pipeline
Body Parameters
company
String
The company name linked to the deal
contact_email
String
The email of the contact linked to the deal
open_date
String
Open date for the deal, yyyy-mm-dd
close_date
String
Close date for the deal, yyyy-mm-dd
deal_size
Integer
The size of the deal
primary_contact
String
The id of the contact linked to the deal
stage
string
Stage of the deal, defaults to Qualification. Stage must be one of the following: Qualification, Discovery, Intrested, Verbal, Proposal, Negotiation, Won, Lost
owner
String
Display name of the deal owner
notes
String
Any notes attached to the deal
Request
[
{
"id": "123456789010",
"stage": "Discovery",
"deal_size": 1,
"open_date": "2025-06-16"
}
]
Bulk Request
[
{
"id": "123456789010",
"stage": "Discovery",
"deal_size": 1,
"open_date": "2025-06-16"
},
{
"id": "234567890101",
"open_date": "2025-06-16"
}
]
Response:
status
String
Status of get reponse
id
string
Id used to search deal
data
object
Holds the content of the request contact
created_at
String
A timestamp of when the deal was originally created
user_id
String
User id of the owner of the deal
contact_email
String
The email of the contact linked to the deal
open_date
String
Open date for the deal
close_date
String
Close date for the deal
company
String
The company name linked to the deal
deal_size
Integer
The size of the deal
primary_contact
String
The id of the contact linked to the deal
stage
string
Stage of the deal
owner
String
Display name of the deal owner
notes
String
Any notes attached to the contact
Response
[
{
"status": "success",
"id": "123456789010",
"data": {
"created_at": "2025-05-20T14:23:32.758077+00:00",
"user_id": "345678901012",
"deal_size": 5000,
"primary_contact": "234567890101",
"stage": "Interested",
"open_date": "2025-05-20",
"close_date": "2025-06-07",
"owner": "Jane",
"company": "Eample Inc",
"id": "123456789010",
"notes": "",
"contact_email": "doe.john@example.com"
}
}
]