PATCH /crm/v3/objects/0-3/{dealId}
Perform a partial update of an Object identified by {dealId}or optionally a unique property value as specified by the idProperty query param. {dealId} refers to the internal object ID by default, and the idProperty query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Servers
- https://api.hubapi.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
dealId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
idProperty |
String | No |
The name of a property whose values are unique for this object type |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
properties |
Object | Yes |
Key value pairs representing the properties of the object. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.