Skip to main content

Deal APIs

This APIs will help you to manage your deals and pipelines records.

You will be able to do the following:

  • Deal:
    • Create, Retrieve, Update and Delete
  • Pipeline:
    • Create, Retrieve, Update and Delete
  • Stage:
    • Delete

API


Bulk Delete Deal

Bulk Delete Deal.

Description:
  • Allows you to delete large volume of deal.

DELETE

/v1/crm/deals

Request URL
https://bifrost.deskera.com/v1/crm/deals
Curl
curl -X DELETE "https://bifrost.deskera.com/v1/crm/deals" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d "{ \"ids\": [ 1,2 ]}"
Parameters
NameLocated inDescriptionRequiredSchema
pipelinebodyBulk Delete dealYesBulkOperations
Responses
CodeDescriptionSchema
204
Security
Security SchemaScopes
ApiKeyAuth

Get Deals

Get Deals.

Description:
  • Allows you to retrieve a list of deal records.

GET

/v1/crm/deals

Request URL
https://bifrost.deskera.com/v1/crm/deals
Curl
curl -X GET "https://bifrost.deskera.com/v1/crm/deals" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
pipeline_idqueryPipeline IDNointeger
deal_summaryqueryIs deal summaryNoboolean
contact_idqueryContact idNostring
deal_idsqueryDeal idsNostring
show_closed_dealsqueryShow Closed deals flagNoboolean
Sample Response
{
"data": [
{
"id": 501,
"name": "Test",
"pipeline_id": 360,
"stage_id": 2261,
"stage": {
"pipeline_id": 360,
"order": 6,
"name": "Closed won",
"deal_probability": 100,
"rotting_days": 30,
"help_text": "",
"system_generated": false,
"won_lost_status": ""
},
"contact_id": 6768,
"organization_id": 6767,
"mobile": "",
"email": "",
"currency_code": "USD",
"amount": 0,
"closing_date": "2020-06-17T10:44:21.345Z",
"status": 0,
"activity_id": 0,
"owner_id": 6517,
"is_deleted": false,
"reason": "",
"created_at": "2020-06-17T10:44:48.686512Z",
"total_activities": 0,
"next_activity_date": ""
}
],
"page": 1,
"number_of_elements": 2,
"size_per_page": 10,
"total_pages": 1,
"number_of_records": 2
}
Responses
CodeDescriptionSchema
200OKFilterConfig
Security
Security SchemaScopes
ApiKeyAuth

Bulk Update Deal

Bulk Update Deal.

Description:
  • Allows you to update a large amount of deal records at once.

PATCH

/v1/crm/deals

Request URL
https://bifrost.deskera.com/v1/crm/deals
Curl
curl -X PATCH "https://bifrost.deskera.com/v1/crm/deals" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d "{ \"ids\": [ 1,2 ], \"pipeline_id\": 1, \"stage_id\":32, \"reason\": \"Test reason\", \"status\": 2}"
Parameters
NameLocated inDescriptionRequiredSchema
pipelinebodyBulk Update dealYesBulkUpdateDealReq
Sample request
{
"ids": [
1,2
],
"owner_id": 12,
"pipeline_id": 1,
"stage_id":2,
"reason": "Test reason",
"status": 2,
"tenantId": 1234
}
Sample Response
[1,2]
Responses
CodeDescriptionSchema
200OKint
Security
Security SchemaScopes
ApiKeyAuth

Create Deal

Add deal.

Description:
  • Allows you to create a new deal record.

POST

/v1/crm/deals

Request URL
https://bifrost.deskera.com/v1/crm/deals
Curl
curl -X POST "https://bifrost.deskera.com/v1/crm/deals" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d "{\"name\": \"TestDeal1\",\"contact_id\": 0,\"contact_name\": \"Paul\",\"organization_name\": \"Paul Org \",\"organization_id\": 0,\"email\": \"\",\"currency_code\": \"SGD\",\"amount\": 0,\"stage_id\": 3169,\"pipeline_id\": 492,\"closing_date\": \"2020-06-23T07:30:26.438Z\",\"custom_field\": [],\"owner_id\": 9547,\"sub_owner_ids\": [],\"visibility_type\": \"team\"}"
Parameters
NameLocated inDescriptionRequiredSchema
pipelinebodyAdd dealYesDealRequest
Sample Request
{
"name": "TestDeal",
"contact_id": 0,
"contact_name": "Paul",
"organization_name": "Paul Org ",
"organization_id": 0,
"email": "",
"currency_code": "SGD",
"amount": 0,
"stage_id": 3169,
"pipeline_id": 492,
"closing_date": "2020-06-23T07:30:26.438Z",
"custom_field": [

],
"owner_id": 9547,
"sub_owner_ids": [

],
"visibility_type": "team"
}
Sample Response
{
"id": 1,
"success": true
}
Responses
CodeDescriptionSchema
201CreatedCUDRecordResponse
Security
Security SchemaScopes
ApiKeyAuth

Delete Deal

Delete Deal.

Description:
  • Allows you to delete deal record.

DELETE

/v1/crm/deals/{id}

Request URL
https://bifrost.deskera.com/v1/crm/deals/1
Curl
curl -X DELETE "https://bifrost.deskera.com/v1/crm/deals/1" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
idpathDeal IDYesinteger
Responses
CodeDescription
204
Security
Security SchemaScopes
ApiKeyAuth

Get Deal by Id

Get Deal by id.

Description:
  • Allows you to retrieve deal record by it's id.

GET

/v1/crm/deals/{id}

Request URL
https://bifrost.deskera.com/v1/crm/deals/1
Curl
curl -X GET "https://bifrost.deskera.com/v1/crm/deals/1" -H "accept: application/json"  -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
idpathDeal IDYesinteger
Sample Response
{
"id": 501,
"name": "Test",
"pipeline_id": 360,
"stage_id": 2261,
"stage": {
"pipeline_id": 360,
"order": 6,
"name": "Closed won",
"deal_probability": 100,
"rotting_days": 30,
"help_text": "",
"system_generated": false,
"won_lost_status": ""
},
"contact_id": 6768,
"organization_id": 6767,
"mobile": "",
"email": "",
"currency_code": "USD",
"amount": 0,
"closing_date": "2020-06-17T10:44:21.345Z",
"status": 0,
"activity_id": 0,
"owner_id": 6517,
"is_deleted": false,
"reason": "",
"created_at": "2020-06-17T10:44:48.686512Z",
"total_activities": 0,
"next_activity_date": ""
}
Responses
CodeDescriptionSchema
200OKDealResponse
Security
Security SchemaScopes
ApiKeyAuth

Update Deal

Update Deal by id.

Description:
  • Allows you to update deal record by it's id.

PUT

/v1/crm/deals/{id}

Request URL
https://bifrost.deskera.com/v1/crm/deals/1
Curl
curl -X PUT "https://bifrost.deskera.com/v1/crm/deals/1" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d "{\"name\": \"TestDeal123\",\"contact_id\": 0,\"contact_name\": \"Paul\",\"organization_name\": \"Paul Org \",\"organization_id\": 0,\"email\": \"\",\"currency_code\": \"SGD\",\"amount\": 0,\"stage_id\": 3169,\"pipeline_id\": 492,\"closing_date\": \"2020-06-23T07:30:26.438Z\",\"custom_field\": [],\"owner_id\": 9547,\"sub_owner_ids\": [],\"visibility_type\": \"team\"}"
Parameters
NameLocated inDescriptionRequiredSchema
idpathDeal IDYesinteger
pipelinebodyUpdate dealYesDeal
Sample Request
{
"name": "TestDeal",
"contact_id": 0,
"contact_name": "Paul",
"organization_name": "Paul Org ",
"organization_id": 0,
"email": "",
"currency_code": "SGD",
"amount": 0,
"stage_id": 3169,
"pipeline_id": 492,
"closing_date": "2020-06-23T07:30:26.438Z",
"custom_field": [

],
"owner_id": 9547,
"sub_owner_ids": [

],
"visibility_type": "team"
}
Sample Response
{
"id": 1,
"success": true
}
Responses
CodeDescriptionSchema
200OKCUDRecordResponse
Security
Security SchemaScopes
ApiKeyAuth

Get Pipelines

Get Pipelines.

Description:
  • Allows you to retrieve a list of pipeline details.

GET

/v1/crm/deals/pipelines

Request URL
https://bifrost.deskera.com/v1/crm/deals/pipelines
Curl
curl -X GET "https://bifrost.deskera.com/v1/crm/deals/pipelines" -H "accept: application/json"  -H "x-access-token: sampleaccesstoken"
Sample Response
[
{
"id": 1,
"name": "Default Pipeline",
"created_by": 6517,
"created_at": "2020-06-17T05:10:26.374137Z",
"updated_at": "2020-06-17T05:10:26.374137Z",
"tenantId": 5148,
"stages": [
{
"id": 2256,
"order": 1,
"name": "Appointment scheduled",
"deal_probability": 20,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.37774Z",
"updated_at": "2020-06-17T05:10:26.37774Z",
"deals": null,
"help_text": "Appointment scheduled",
"system_generated": false,
"won_lost_status": "open"
},
{
"id": 2257,
"order": 2,
"name": "Qualified to buy",
"deal_probability": 40,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.381605Z",
"updated_at": "2020-06-17T05:10:26.381605Z",
"deals": null,
"help_text": "Qualified to buy",
"system_generated": false,
"won_lost_status": "open"
},
{
"id": 2258,
"order": 3,
"name": "Presentation scheduled",
"deal_probability": 60,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.384912Z",
"updated_at": "2020-06-17T05:10:26.384912Z",
"deals": null,
"help_text": "Presentation scheduled",
"system_generated": false,
"won_lost_status": "open"
},
{
"id": 2259,
"order": 4,
"name": "Decision-maker bought-in",
"deal_probability": 80,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.388407Z",
"updated_at": "2020-06-17T05:10:26.388407Z",
"deals": null,
"help_text": "Decision-maker bought-in",
"system_generated": false,
"won_lost_status": "open"
},
{
"id": 2260,
"order": 5,
"name": "Contract sent",
"deal_probability": 90,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.393173Z",
"updated_at": "2020-06-17T05:10:26.393173Z",
"deals": null,
"help_text": "Contract sent",
"system_generated": false,
"won_lost_status": "open"
},
{
"id": 2261,
"order": 6,
"name": "Closed won",
"deal_probability": 100,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.398307Z",
"updated_at": "2020-06-17T05:10:26.398307Z",
"deals": [
{
"id": 501,
"name": "Test",
"stage": null,
"contact_id": 6768,
"organization_id": 6767,
"mobile": "9876543212",
"email": "test@test.com",
"currency_code": "USD",
"amount": 0,
"closing_date": "2020-06-17T10:44:21.345Z",
"status": 0,
"activity_id": 0,
"owner_id": 6517,
"is_deleted": false,
"reason": "",
"created_at": "2020-06-17T10:44:48.686512Z",
"total_activities": 0,
"next_activity_date": ""
}
],
"help_text": "Closed won",
"system_generated": true,
"won_lost_status": "won"
},
{
"id": 2262,
"order": 7,
"name": "Closed lost",
"deal_probability": 0,
"rotting_days": 30,
"created_at": "2020-06-17T05:10:26.401914Z",
"updated_at": "2020-06-17T05:10:26.401914Z",
"deals": null,
"help_text": "Closed lost",
"system_generated": true,
"won_lost_status": "lost"
}
]
}
]
Responses
CodeDescriptionSchema
200OKPipeline
Security
Security SchemaScopes
ApiKeyAuth

Create Pipeline

Create Pipeline.

Description:
  • Allows you to cretae new pipeline.

POST

/v1/crm/deals/pipelines:

Request URL
https://bifrost.deskera.com/v1/crm/deals/pipelines
Curl
curl -X POST "https://bifrost.deskera.com/v1/crm/deals/pipelines" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d "{ \"name\": \"Test Pipeline\", \"stages\": [ { \"order\": 1, \"name\": \"l1\", \"deal_probability\": 30, \"rotting_days\": 10, \"help_text\":\"Level1\", \"system_generated\":false, \"won_lost_status\":\"open\" }, { \"order\": 2, \"name\": \"Won\", \"deal_probability\": 30, \"rotting_days\": 10, \"help_text\":\"Won\", \"system_generated\":true, \"won_lost_status\":\"won\" }, { \"order\": 3, \"name\": \"Lost\", \"deal_probability\": 30, \"rotting_days\": 10, \"help_text\":\"Lost\", \"system_generated\":true, \"won_lost_status\":\"lost\" } ]}"
Parameters
NameLocated inDescriptionRequiredSchema
pipelinebodyCreate PipelineYesPipeline
Sample request
{
"name": "Test Pipeline",
"stages": [
{
"order": 1,
"name": "l1",
"deal_probability": 30,
"rotting_days": 10,
"help_text":"Level1",
"system_generated":false,
"won_lost_status":"open"
},
{
"order": 2,
"name": "Won",
"deal_probability": 30,
"rotting_days": 10,
"help_text":"Won",
"system_generated":true,
"won_lost_status":"won"
},
{
"order": 3,
"name": "Lost",
"deal_probability": 30,
"rotting_days": 10,
"help_text":"Lost",
"system_generated":true,
"won_lost_status":"lost"
}
]
}
Sample Response
{
"Success": true,
"Id": 22
}
Responses
CodeDescriptionSchema
201CreatedCUDRecordResponse
Security
Security SchemaScopes
ApiKeyAuth

Delete Pipeline

Delete Pipeline.

Description:
  • Allows you to delete existing pipeline.

DELETE

/v1/crm/deals/pipelines/{id}

Request URL
https://bifrost.deskera.com/v1/crm/deals/pipelines/1
Curl
curl -X DELETE "https://bifrost.deskera.com/v1/crm/deals/pipelines/1" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
idpathPipeline IDYesinteger
Responses
CodeDescriptionSchema
204
Security
Security SchemaScopes
ApiKeyAuth

Get Pipeline by Id

Get Pipeline by id.

Description:
  • Allows you to retrieve pipeline details by it's id.

GET

/v1/crm/deals/pipelines/{id}

Request URL
https://bifrost.deskera.com/v1/deals/pipelines/1
Curl
curl -X GET "https://bifrost.deskera.com/v1/crm/deals/pipelines/1" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
idpathPipeline IDYesinteger
Sample Response
{
"id": 1,
"name": "Test pipeline",
"created_by": 6517,
"created_at": "2020-05-22T13:09:57.2966+05:30",
"updated_at": "2020-05-22T13:09:57.2966+05:30",
"tenantId": 5148,
"stages": [
{
"id": 1,
"order": 1,
"name": "level1",
"deal_probability": 30,
"rotting_days": 10,
"created_at": "2020-05-22T13:09:57.297464+05:30",
"updated_at": "2020-05-22T13:09:57.297464+05:30",
"deals": [
{
"id": 2,
"name": "New one",
"stage": null,
"contact_id": 245,
"organization_id": 246,
"mobile": "9876543212",
"email": "a@a.com",
"currency_code": "SGD",
"amount": 12,
"closing_date": "2020-05-02T13:44:19.607+05:30",
"status": 2,
"activity_id": 0,
"owner_id": 6517,
"is_deleted": false,
"reason": "",
"created_at": "2020-05-22T15:14:54.493316+05:30",
"total_activities": 0,
"next_activity_date": ""
}
],
"help_text": "Level1",
"system_generated": false,
"won_lost_status": "open"
},
{
"id": 2,
"order": 2,
"name": "Won",
"deal_probability": 30,
"rotting_days": 10,
"created_at": "2020-05-22T13:09:57.301669+05:30",
"updated_at": "2020-05-22T13:09:57.301669+05:30",
"deals": null,
"help_text": "Won",
"system_generated": true,
"won_lost_status": "won"
},
{
"id": 3,
"order": 3,
"name": "Lost",
"deal_probability": 30,
"rotting_days": 10,
"created_at": "2020-05-22T13:09:57.302567+05:30",
"updated_at": "2020-05-22T13:09:57.302567+05:30",
"deals": null,
"help_text": "Lost",
"system_generated": true,
"won_lost_status": "lost"
}
]
}
Responses
CodeDescriptionSchema
200OKPipeline
Security
Security SchemaScopes
ApiKeyAuth

Update Pipeline

Update Pipeline.

Description:
  • Allows you to update existing pipeline details.

PUT

/v1/crm/deals/pipelines/{id}

Request URL
https://bifrost.deskera.com/v1/crm/deals/pipelines/2
Curl
curl -X PUT "https://bifrost.deskera.com/v1/crm/deals/pipelines/2" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d "{ \"name\": \"Updated Test Pipeline\", \"stages\": [ { \"order\": 1, \"name\": \"l1\", \"deal_probability\": 30, \"rotting_days\": 10, \"help_text\":\"Level1\", \"system_generated\":false, \"won_lost_status\":\"open\" }, { \"order\": 2, \"name\": \"Won\", \"deal_probability\": 30, \"rotting_days\": 10, \"help_text\":\"Won\", \"system_generated\":true, \"won_lost_status\":\"won\" }, { \"order\": 3, \"name\": \"Lost\", \"deal_probability\": 30, \"rotting_days\": 10, \"help_text\":\"Lost\", \"system_generated\":true, \"won_lost_status\":\"lost\" } ]}"
Parameters
NameLocated inDescriptionRequiredSchema
idpathPipeline IDYesinteger
pipelinebodyUpdate PipelineYesPipeline
Sample Request
{
"name": "Updated Test Pipeline",
"stages": [
{
"order": 1,
"name": "l1",
"deal_probability": 30,
"rotting_days": 10,
"help_text":"Level1",
"system_generated":false,
"won_lost_status":"open"
},
{
"order": 2,
"name": "Won",
"deal_probability": 30,
"rotting_days": 10,
"help_text":"Won",
"system_generated":true,
"won_lost_status":"won"
},
{
"order": 3,
"name": "Lost",
"deal_probability": 30,
"rotting_days": 10,
"help_text":"Lost",
"system_generated":true,
"won_lost_status":"lost"
}
]
}
Sample Response
{
"Success":true,
"Id":2
}
Responses
CodeDescriptionSchema
200OKCUDRecordResponse

Delete Stage by Id

Delete Stage.

Description:
  • Allows you to delete stage by it's id.

DELETE

/v1/crm/deals/pipelines/stages/{id}

Request URL
https://bifrost.deskera.com/v1/pipelines/stages/1
Curl
curl -X DELETE "https://bifrost.deskera.com/v1/crm/deals/pipelines/stages/1" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
idpathStage IDYesinteger
Responses
CodeDescriptionSchema
204
Security
Security SchemaScopes
ApiKeyAuth

Models


CUDRecordResponse

NameTypeDescriptionRequired
idintegerNo
successbooleanNo

BulkOperations

NameTypeDescriptionRequired
ids[ integer ]No

BulkUpdateDealReq

NameTypeDescriptionRequired
ids[ integer ]No
owner_idintegerNo
pipeline_idintegerNo
reasonstringNo
stage_idintegerNo
statusintegerNo
tenantIdintegerNo

Contact

NameTypeDescriptionRequired
addressstringNo
country_codestringNo
created_byintegerNo
created_datestringNo
emailstringNo
idintegerNo
labelContactLabelNo
label_idintegerNo
logostringNo
namestringNo
notestringNo
organization_idintegerNo
owner_idintegerNo
phonestringNo
sub_owner_idsstringNo
tenant_idintegerNo
typestringorganizationperson
updated_byintegerNo
updated_datestringNo
visibility_idsstringNo
visibility_typestringprivatepublic

ContactLabel

NameTypeDescriptionRequired
colorstringNo
iconstringNo
idintegerNo
namestringNo

CustomField

NameTypeDescriptionRequired
codestringNo
labelstringNo
modulestringNo
shortNamestringNo
valuestringNo

DealRequest

NameTypeDescriptionRequired
amountnumberNo
closing_datestringNo
contactContactNo
contact_idintegerNo
contact_namestringNo
currency_codestringNo
custom_field[ CustomField ]No
emailstringNo
idintegerNo
mobilestringNo
namestringNo
organizationContactNo
organization_idintegerNo
organization_namestringNo
ownerUserAndTeamsNo
owner_idintegerNo
pipeline_idintegerNo
reasonstringNo
stage_idintegerNo
statusintegerNo

DealResponse

NameTypeDescriptionRequired
activity_idintegerNo
amountnumberNo
closing_datestringNo
contact_idintegerNo
contact_infostringNo
created_atstringNo
currency_codestringNo
custom_field[ CustomField ]No
emailstringNo
idintegerNo
is_deletedbooleanNo
mobilestringNo
namestringNo
next_activity_datestringNo
organization_idintegerNo
organization_infostringNo
owner_idintegerNo
owner_infostringNo
pipeline_idintegerNo
reasonstringNo
stageStageDtoResponseNo
stage_idintegerNo
statusintegerNo
total_activitiesintegerNo

FilterConfig

NameTypeDescriptionRequired
dataobjectNo
number_of_elementsintegerNo
number_of_recordsintegerNo
pageintegerNo
size_per_pageintegerNo
total_pagesintegerNo

Pipeline

NameTypeDescriptionRequired
created_atstringNo
created_byintegerNo
idintegerNo
namestringNo
stages[ StageDto ]No
tenantIdintegerNo
updated_atstringNo

StageDto

NameTypeDescriptionRequired
created_atstringNo
deal_probabilityintegerNo
deals[ DealResponse ]No
help_textstringNo
idintegerNo
namestringNo
orderintegerNo
rotting_daysintegerNo
system_generatedbooleanNo
updated_atstringNo
won_lost_statusstringNo

StageDtoResponse

NameTypeDescriptionRequired
deal_probabilityintegerNo
help_textstringNo
namestringNo
orderintegerNo
pipeline_idintegerNo
rotting_daysintegerNo
system_generatedbooleanNo
won_lost_statusstringNo

UserAndTeams

NameTypeDescriptionRequired
userstringNo

Deal

NameTypeDescriptionRequired
amountnumberNo
c_fieldstringNo
closing_datestringNo
contact_idintegerNo
created_atstringNo
created_byintegerNo
currency_codestringNo
custom_fieldstringNo
emailstringNo
idintegerNo
is_deletedbooleanNo
mobilestringNo
namestringNo
organization_idintegerNo
owner_idintegerNo
pipeline_idintegerNo
reasonstringNo
stageStageModelNo
stage_idintegerNo
statusintegerNo
tenant_idintegerNo
updated_atstringNo
updated_byintegerNo

StageModel

NameTypeDescriptionRequired
created_byintegerNo
created_dtstringNo
deal_probabilityintegerNo
deals[ Deal ]No
help_textstringNo
idintegerNo
is_deletedbooleanNo
namestringNo
orderintegerNo
pipeline_idintegerNo
rotting_daysintegerNo
system_generatedbooleanNo
tenantIdintegerNo
updated_byintegerNo
updated_dtstringNo
won_lost_statusstringNo