Skip to main content
PATCH
/
deals
/
{id}
cURL
curl --request PATCH \
  --url https://api.dock.us/{version}/deals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFields": [
    {
      "id": "<string>",
      "value": "Single line of text"
    }
  ]
}
'
{
  "data": {
    "deal": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "hubspotDealId": "1234567890",
      "object": "deal",
      "url": "https://api.dock.us/v1/deals/RiHO4e0Ju3DS",
      "createdDate": "2024-01-01T00:00:00Z",
      "closeDate": "2024-01-01T00:00:00Z",
      "name": "Deal 1",
      "amount": "100000",
      "type": "New Business",
      "stage": "Proposal Sent"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

​
properties
enum<string>[]

Select the deal properties that should be returned

Available options:
hubspotDealId,
salesforceOpportunityId,
name,
amount,
closeDate,
createdDate,
stage,
type,
customFields.name,
customFields.type,
customFields.variableName,
customFields.value,
createdAt,
updatedAt

Body

application/json
​
customFields
(Single-line text · object | Multi-line text · object | Date · object | Number · object | Single checkbox · object | Multiple checkboxes · object | Dropdown select · object | Radio select · object)[]

Custom fields to update

Response

Deal updated

​
data
object