Skip to main content
PATCH
/
api
/
v1
/
lead-deals
/
{dealId}
Update Deal
curl --request PATCH \
  --url https://app.journeybee.io/api/v1/lead-deals/{dealId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "deal_value": 123,
  "stage_uuid": "<string>",
  "payment_stage_uuid": "<string>",
  "tags": [
    {}
  ],
  "customFields": [
    {}
  ]
}
'
{
  "id": 456,
  "uuid": "deal-uuid-456",
  "updated_at": "2024-01-15T16:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

curl -X PATCH "https://app.journeybee.io/api/v1/lead-deals/{dealId}" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json" \
  -d '{"deal_value": 300000, "stage_uuid": "new-stage-uuid"}'

​
Path Parameters

​
dealId
number
required
The unique identifier of the deal to update

​
Request Body Schema

​
label
string
Deal name/title
​
deal_value
number
Deal value (triggers commission recalculation)
​
stage_uuid
string
UUID of the stage to move this deal to
​
payment_stage_uuid
string
UUID of the payment stage for commission tracking
​
tags
array
Array of tag IDs to assign (replaces existing tags)
​
customFields
array
Array of custom field values to update

​
Response Schema

​
id
number
The updated deal ID
​
uuid
string
The deal UUID
​
updated_at
string
Timestamp of when the deal was last updated

​
Example Response

{
  "id": 456,
  "uuid": "deal-uuid-456",
  "updated_at": "2024-01-15T16:30:00Z"
}

​
Notes

  • Requires API key with write_access permission
  • Deal value changes trigger automatic commission recalculation
  • Stage changes may trigger business rule validations and notifications
  • Partnership deals sync changes to partner companies