Deals

Update a deal

patch/v1/deals/{id}

Request

  • Base URL: https://app.getdealboard.com
  • URL: https://app.getdealboard.com/v1/deals/{id}
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional client-chosen string. If the same key is sent twice within 24h with the same body, the original response is replayed.

Request body

namestring
companystring nullable
amountCentsinteger nullable
stageIdstring

For side-effect-aware stage changes (auto-stamp won/dead/commitment dates), prefer POST /v1/deals/{id}/move.

ownerIdstring uuid
labelsstring[]
primaryContactNamestring nullable
primaryContactTitlestring nullable
primaryContactEmailstring nullable
primaryContactPhonestring nullable
primaryContactLinkedinstring nullable
keyTermsstring nullable

Response

OK

idstring uuid required
boardIdstring uuid required
namestring required
companystring nullable required
amountCentsinteger nullable required

Deal value in minor currency units (cents). No floats.

currency'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' | 'JPY' | 'INR' required
ownerIdstring uuid required
ownerNamestring nullable required
labelsstring[] required
keyTermsstring nullable required
createdAtstring date-time required
updatedAtstring date-time required
stageEnteredAtstring date-time required
commitmentAtstring date-time nullable required
wonAtstring date-time nullable required
deadAtstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.