Deals
Update a deal
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Deals
Update a deal
PATCH
/
deals
/
{id}
curl --request PATCH \
--url https://api.dock.so:4000/{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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier
Example:
"RiHO4e0Ju3DS"
Query Parameters
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
Response
200
application/json
Deal updated
Id of the object
Example:
"RiHO4e0Ju3DS"
Last updated date
Example:
"2021-01-01T00:00:00.000Z"
Created at date
Example:
"2021-01-01T00:00:00.000Z"
Type of the object
Available options:
deal
Example:
"deal"
URL to the resource
Example:
"https://api.dock.us/v1/deals/RiHO4e0Ju3DS"
Created date of the deal
Example:
"2024-01-01T00:00:00Z"
Close date of the deal
Example:
"2024-01-01T00:00:00Z"
Name of the deal
Example:
"Deal 1"
Amount of the deal
Example:
"100000"
Type of the deal
Example:
"New Business"
Stage of the deal
Example:
"Proposal Sent"
HubSpot deal ID
Example:
"1234567890"
curl --request PATCH \
--url https://api.dock.so:4000/{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"
}
}
}