PATCH /crm/deals/{id}
Update an existing deal''s attributes, name, linked contacts, or linked companies. Note that passing linkedContactsIds or linkedCompaniesIds replaces the entire list of associations, so omitted IDs will be removed. To move a deal to a different pipeline or stage, provide both the pipeline and deal_stage attribute IDs.
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
attributes |
Object | No |
Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the |
name |
String | No |
Name of deal |
linkedContactsIds[] |
Array | No |
Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. |
linkedCompaniesIds[] |
Array | No |
Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed. |
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.