Rest API endpoints for pipeline deals
Creating Pipeline Deal
Description:
Creates a new pipeline deal and stores it in the CRM system.
Request Headers:
x-api-key: <your-api-key>
Request Method:
POST
Fields:
company
String
Required
Name of company that deal is with
stage
String
Stage that the deal is in, must be a valid
stage.
Valid stages are: Qualification, Discovery, Intrested,
Verbal, Proposal, Negotiation.
deal_size
Integer
Size of deal, defaults to zero if not provided
open_date
String
date that the deal was opened, if not provided, defaults to current date
est_close_date
String
estimate close date of deal.
primary_contact
String
Email of primary contact for deal
notes
String
notes about the deal
Request Example
{
"company": "Example Inc.",
"deal_size": 15000,
"stage": "Qualification",
"open_date": "2021-09-01",
"est_close_date": "2021-12-01",
"primary_contact": "example@gmail.com",
"notes": "example notes"
}
Returns:
Status : 200
id
String
Id of the newly created pipeline deal
Response Example
{
"id": "12345678901234567890"
}
Reading Pipeline Deals
Description:
Querrys your pipeline deals and returns matching deals
Request Headers:
x-api-key: <your-api-key>
Request Method:
GET
Fields:
searchby
String
Required
Parameters to search by. Search must be a valid pipeline field.
search
String
Required
Term to search by
Request Example
{
"searchby": "stage",
"search": "Preposal"
}
Returns:
Status : 200
id
String
Id of the newly created contact
Response Example
{
"id": "12345678901234567890"
}
Editing Pipeline Deal
Description:
Edit the fields of a pipeline deal
Request Headers:
x-api-key: <your-api-key>
Request Method:
POST
Fields:
pipeline_deal_id
String
Required
Id of pipeline deal to update
update_fields
Object
Required
Object that contains the properties to
update on the contact
these properties are:
company, stage, deal_size, open_date,
est_close_date, primary_contact, notes
Request Example
{
"contactID": "12345678901234567890",
"updateFields": {
"stage": "Verbal",
"deal_size": 30000,
"notes": "new notes"
}
}
Returns:
Status : 200
id
String
Id of the newly created contact
Response Example
{
"id": "12345678901234567890"
}
Deleting Pipeline Deals
Description:
Deletes a pipeline deal from the CRM system
Request Headers:
x-api-key: <your-api-key>
Request Method:
DELETE
Fields:
pipeline_deal_id
String
Required
Id of pipeline deal to delete
Request Example
{
"pipeline_deal_id": "12345678901234567890"
}
Returns:
Status : 200
Response Body
"Document deleted successfully"
Response Example
Document deleted successfully