/brevo-crm | Type: Application | PCID required: Yes
Tools
brevo_crm_create_companies
Create a company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attributes | object | No | — | Attributes for company creation |
countryCode | integer | No | — | Country code if phone_number is passed in attributes. |
linkedContactsIds | integer[] | No | — | Contact ids to be linked with company |
linkedDealsIds | string[] | No | — | Deal ids to be linked with company |
name | string | Yes | — | Name of company |
brevo_crm_create_companies_import
Import companies(creation and updation) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | No | — | The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update companies] (b) associated_contact (c) associated_deal (f) any other attribute with internal name |
mapping | object | No | — | The mapping options in JSON format. Here is an example of the JSON structure: json { "link_entities": true, // Determines whether to link related entities during the import process "unlink_entities": false, // Determines whether to unlink related entities during the import process "update_existing_records": true, // Determines whether to update based on company ID or treat every row as create "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank } |
brevo_crm_create_crm_attributes
Create a company/deal attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attributeType | string | Yes | — | The type of attribute (must be one of the defined enums) |
description | string | No | — | A description of the attribute |
label | string | Yes | — | The label for the attribute (max 50 characters, cannot be empty) |
objectType | string | Yes | — | The type of object the attribute belongs to. Must be either companies or deals. |
optionsLabels | string[] | No | — | Options for multi-choice or single-select attributes |
brevo_crm_create_crm_deals
Create a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attributes | object | No | — | Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes pipeline and deal_stage. Pipeline and deal_stage are ids you can fetch using this endpoint /crm/pipeline/details/{pipelineID} |
linkedCompaniesIds | string[] | No | — | Company ids to be linked with deal |
linkedContactsIds | integer[] | No | — | Contact ids to be linked with deal |
name | string | Yes | — | Name of deal |
brevo_crm_create_crm_deals_import
Import deals(creation and updation) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | No | — | The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) deal_id [brevo mongoID to update deals] (b) associated_contact (c) associated_company (f) any other attribute with internal name |
mapping | object | No | — | The mapping options in JSON format. Here is an example of the JSON structure: json { "link_entities": true, // Determines whether to link related entities during the import process "unlink_entities": false, // Determines whether to unlink related entities during the import process "update_existing_records": true, // Determines whether to update based on deal ID or treat every row as create "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank } |
brevo_crm_create_crm_files
Upload a file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyId | string | No | — | Company Id |
contactId | integer | No | — | Contact Id |
dealId | string | No | — | Deal Id |
file | string | Yes | — | File data to create a file. |
brevo_crm_create_crm_notes
Create a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyIds | string[] | No | — | Company Ids linked to a note |
contactIds | integer[] | No | — | Contact Ids linked to a note |
dealIds | string[] | No | — | Deal Ids linked to a note |
text | string | Yes | — | Content of the note. Supports HTML for rich text formatting. Supported tags include: <p> (paragraph), <b> / <strong> (bold), <i> / <em> (italic), <u> (underline), <br> (line break), <a href="..."> (labelled hyperlink). Example labelled link: <a href="https://example.com">Link text</a>. |
brevo_crm_create_crm_tasks
Create a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assignToId | string | No | — | To assign a task to a user you can use either the account email or ID. |
companiesIds | string[] | No | — | Companies ids for companies a task is linked to |
contactsIds | integer[] | No | — | Contact ids for contacts linked to this task |
date | string | Yes | — | Task due date and time |
dealsIds | string[] | No | — | Deal ids for deals a task is linked to |
done | boolean | No | — | Task marked as done |
duration | integer | No | — | Duration of task in milliseconds [1 minute = 60000 ms] |
name | string | Yes | — | Name of task |
notes | string | No | — | Notes added to a task |
reminder | object | No | — | Task reminder date/time for a task |
taskTypeId | string | Yes | — | Id for type of task e.g Call / Email / Meeting etc. |
brevo_crm_delete_attributes_by_id
Delete an attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Attribute ID |
brevo_crm_delete_companies_by_id
Delete a company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Company ID to delete |
brevo_crm_delete_deals_by_id
Delete a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
brevo_crm_delete_files_by_id
Delete a file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | File id to delete. |
brevo_crm_delete_notes_by_id
Delete a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Note ID to delete |
brevo_crm_delete_tasks_by_id
Delete a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
brevo_crm_get_companies_by_id
Get a company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Get Company Details |
brevo_crm_get_deals_by_id
Get a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
brevo_crm_get_files_by_id
Download a file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | File id to download. |
brevo_crm_get_notes_by_id
Get a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Note ID to get |
brevo_crm_get_pipeline_details_by_pipeline_id
Get a pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pipelineID | string | Yes | — | Pipeline ID |
brevo_crm_get_tasks_by_id
Get a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
brevo_crm_list_companies
Get all Companies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filters[attributes.name] | string | No | — | Filter by attributes. If you have a filter for the owner on your side please send it as filters[attributes.owner] and utilize the account email for the filtering. |
linkedContactsIds | integer | No | — | Filter by linked contacts ids |
linkedDealsIds | string | No | — | Filter by linked Deals ids |
modifiedSince | string | No | — | Filter (urlencoded) the companies modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
createdSince | string | No | — | Filter (urlencoded) the companies created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
page | integer | No | — | Index of the first document of the page |
limit | integer | No | — | Number of documents per page |
sort | string | No | — | Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed |
sortBy | string | No | — | The field used to sort field names. |
brevo_crm_list_crm_attributes_companies
Get company attributesbrevo_crm_list_crm_attributes_deals
Get deal attributesbrevo_crm_list_crm_deals
Get all deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filters[attributes.deal_name] | string | No | — | Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering. |
filters[linkedCompaniesIds] | string | No | — | Filter by linked companies ids |
filters[linkedContactsIds] | string | No | — | Filter by linked contacts ids |
modifiedSince | string | No | — | Filter (urlencoded) the deals modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
createdSince | string | No | — | Filter (urlencoded) the deals created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
offset | integer | No | — | Index of the first document of the page |
limit | integer | No | — | Number of documents per page |
sort | string | No | — | Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed |
sortBy | string | No | — | The field used to sort field names. |
brevo_crm_list_crm_files
Get all files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entity | string | No | — | Filter by file entity type |
entityIds | string | No | — | Filter by file entity IDs |
dateFrom | integer | No | — | dateFrom to date range filter type (timestamp in milliseconds) |
dateTo | integer | No | — | dateTo to date range filter type (timestamp in milliseconds) |
offset | integer | No | — | Index of the first document of the page |
limit | integer | No | — | Number of documents per page |
sort | string | No | — | Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed |
brevo_crm_list_crm_files_by_id_data
Get file details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | File id to get file data. |
brevo_crm_list_crm_notes
Get all notes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entity | string | No | — | Filter by note entity type |
entityIds | string | No | — | Filter by note entity IDs |
dateFrom | integer | No | — | dateFrom to date range filter type (timestamp in milliseconds) |
dateTo | integer | No | — | dateTo to date range filter type (timestamp in milliseconds) |
offset | integer | No | — | Index of the first document of the page |
limit | integer | No | — | Number of documents per page |
sort | string | No | — | Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed |
brevo_crm_list_crm_pipeline_details_all
Get all pipelinesbrevo_crm_list_crm_tasks
Get all tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[type] | string | No | — | Filter by task type (ID) |
filter[status] | string | No | — | Filter by task status |
filter[date] | string | No | — | Filter by date |
filter[assignTo] | string | No | — | Filter by the “assignTo” ID. You can utilize account emails for the “assignTo” attribute. |
filter[contacts] | string | No | — | Filter by contact ids |
filter[deals] | string | No | — | Filter by deals ids |
filter[companies] | string | No | — | Filter by companies ids |
dateFrom | integer | No | — | dateFrom to date range filter type (timestamp in milliseconds) |
dateTo | integer | No | — | dateTo to date range filter type (timestamp in milliseconds) |
offset | integer | No | — | Index of the first document of the page |
limit | integer | No | — | Number of documents per page |
sort | string | No | — | Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed |
sortBy | string | No | — | The field used to sort field names. |
brevo_crm_list_crm_tasktypes
Get all task typesbrevo_crm_update_companies_by_id
Update a company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
attributes | object | No | — | Attributes for company update |
countryCode | integer | No | — | Country code if phone_number is passed in attributes. |
linkedContactsIds | integer[] | No | — | Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. |
linkedDealsIds | string[] | No | — | Warning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed. |
name | string | No | — | Name of company |
brevo_crm_update_companies_link_unlink_by_id
Link and Unlink company with contact and deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
linkContactIds | integer[] | No | — | Contact ids for contacts to be linked with company |
linkDealsIds | string[] | No | — | Deal ids for deals to be linked with company |
unlinkContactIds | integer[] | No | — | Contact ids for contacts to be unlinked from company |
unlinkDealsIds | string[] | No | — | Deal ids for deals to be unlinked from company |
brevo_crm_update_crm_attributes_by_id
Update an attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Attribute ID |
label | string | No | — | Attribute display label |
objectType | string | No | — | The type of object the attribute belongs to, it cannot be updated after creation |
optionsLabels | object[] | No | — | Updated labels for selectable options |
brevo_crm_update_crm_deals_by_id
Update a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
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 pipeline and the deal_stage Pipeline and deal_stage are ids you can fetch using this endpoint /crm/pipeline/details/{pipelineID} |
linkedCompaniesIds | string[] | No | — | Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed. |
linkedContactsIds | integer[] | No | — | Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. |
name | string | No | — | Name of deal |
brevo_crm_update_crm_deals_link_unlink_by_id
Link and Unlink a deal with contacts and companies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
linkCompanyIds | string[] | No | — | Company ids to be linked with deal |
linkContactIds | integer[] | No | — | Contact ids for contacts to be linked with deal |
unlinkCompanyIds | string[] | No | — | Company ids to be unlinked from deal |
unlinkContactIds | integer[] | No | — | Contact ids for contacts to be unlinked from deal |
brevo_crm_update_crm_notes_by_id
Update a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Note ID to update |
companyIds | string[] | No | — | Company Ids linked to a note |
contactIds | integer[] | No | — | Contact Ids linked to a note |
dealIds | string[] | No | — | Deal Ids linked to a note |
text | string | Yes | — | Content of the note. Supports HTML for rich text formatting. Supported tags include: <p> (paragraph), <b> / <strong> (bold), <i> / <em> (italic), <u> (underline), <br> (line break), <a href="..."> (labelled hyperlink). Example labelled link: <a href="https://example.com">Link text</a>. |
brevo_crm_update_crm_tasks_by_id
Update a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
assignToId | string | No | — | To assign a task to a user you can use either the account email or ID. |
companiesIds | string[] | No | — | Companies ids for companies a task is linked to |
contactsIds | integer[] | No | — | Contact ids for contacts linked to this task |
date | string | No | — | Task date/time |
dealsIds | string[] | No | — | Deal ids for deals a task is linked to |
done | boolean | No | — | Task marked as done |
duration | integer | No | — | Duration of task in milliseconds [1 minute = 60000 ms] |
name | string | No | — | Name of task |
notes | string | No | — | Notes added to a task |
reminder | object | No | — | Task reminder date/time for a task |
taskTypeId | string | No | — | Id for type of task e.g Call / Email / Meeting etc. |

