Skip to main content
PATCH
/
v1
/
deals
/
{id}
Update deal
curl --request PATCH \
  --url https://api.stardex.ai/v1/deals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency_code": "<string>",
  "compensation": 1,
  "compensation_currency_code": "<string>",
  "pricing_rate": 50,
  "win_probability": 50,
  "deal_status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "closed_date": "<string>",
  "job_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "referred_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_fields": [
    {
      "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "add_values": [
        "<string>"
      ],
      "remove_values": [
        "<string>"
      ],
      "add_team_member_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "remove_team_member_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "clear_all": true
    }
  ]
}
'
{
  "success": true,
  "data": {
    "message": "Deal updated successfully"
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

​
id
string
required

Deal UUID

Body

application/json
​
name
string

Deal name.

Minimum string length: 1
​
client_id
string<uuid>

Client company UUID.

​
amount
number

Deal amount.

​
currency_code
string

ISO 4217 currency code (e.g. USD, EUR, GBP).

Required string length: 3
​
compensation
number

Candidate's expected total annual compensation.

Required range: x >= 0
​
compensation_currency_code
string

ISO 4217 currency code for compensation.

Required string length: 3
​
pricing_rate
number

Recruitment fee percentage (0–100).

Required range: 0 <= x <= 100
​
win_probability
number

Win probability (0–100).

Required range: 0 <= x <= 100
​
deal_status_id
string<uuid>

Deal status UUID.

​
description
string

Description.

​
closed_date
string | null

ISO 8601 close date. Pass null to clear.

​
job_ids
string<uuid>[]

Job UUIDs to link to this deal. Replaces all existing deal_jobs links.

​
referred_by
string<uuid>

Person UUID of the referrer.

​
custom_fields
object[]

Custom field values to update.

Response

Deal updated

​
success
enum<boolean>
required
Available options:
true
​
data
object
required