Skip to main content
Server path: /brevo-crm | Type: Application | PCID required: Yes

Tools

ToolDescription
brevo_crm_create_companiesCreate a company
brevo_crm_create_companies_importImport companies(creation and updation)
brevo_crm_create_crm_attributesCreate a company/deal attribute
brevo_crm_create_crm_dealsCreate a deal
brevo_crm_create_crm_deals_importImport deals(creation and updation)
brevo_crm_create_crm_filesUpload a file
brevo_crm_create_crm_notesCreate a note
brevo_crm_create_crm_tasksCreate a task
brevo_crm_delete_attributes_by_idDelete an attribute
brevo_crm_delete_companies_by_idDelete a company
brevo_crm_delete_deals_by_idDelete a deal
brevo_crm_delete_files_by_idDelete a file
brevo_crm_delete_notes_by_idDelete a note
brevo_crm_delete_tasks_by_idDelete a task
brevo_crm_get_companies_by_idGet a company
brevo_crm_get_deals_by_idGet a deal
brevo_crm_get_files_by_idDownload a file
brevo_crm_get_notes_by_idGet a note
brevo_crm_get_pipeline_details_by_pipeline_idGet a pipeline
brevo_crm_get_tasks_by_idGet a task
brevo_crm_list_companiesGet all Companies
brevo_crm_list_crm_attributes_companiesGet company attributes
brevo_crm_list_crm_attributes_dealsGet deal attributes
brevo_crm_list_crm_dealsGet all deals
brevo_crm_list_crm_filesGet all files
brevo_crm_list_crm_files_by_id_dataGet file details
brevo_crm_list_crm_notesGet all notes
brevo_crm_list_crm_pipeline_details_allGet all pipelines
brevo_crm_list_crm_tasksGet all tasks
brevo_crm_list_crm_tasktypesGet all task types
brevo_crm_update_companies_by_idUpdate a company
brevo_crm_update_companies_link_unlink_by_idLink and Unlink company with contact and deal
brevo_crm_update_crm_attributes_by_idUpdate an attribute
brevo_crm_update_crm_deals_by_idUpdate a deal
brevo_crm_update_crm_deals_link_unlink_by_idLink and Unlink a deal with contacts and companies
brevo_crm_update_crm_notes_by_idUpdate a note
brevo_crm_update_crm_tasks_by_idUpdate a task

brevo_crm_create_companies

Create a company Parameters:
ParameterTypeRequiredDefaultDescription
attributesobjectNoAttributes for company creation
countryCodeintegerNoCountry code if phone_number is passed in attributes.
linkedContactsIdsinteger[]NoContact ids to be linked with company
linkedDealsIdsstring[]NoDeal ids to be linked with company
namestringYesName of company

brevo_crm_create_companies_import

Import companies(creation and updation) Parameters:
ParameterTypeRequiredDefaultDescription
filestringNoThe 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
mappingobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
attributeTypestringYesThe type of attribute (must be one of the defined enums)
descriptionstringNoA description of the attribute
labelstringYesThe label for the attribute (max 50 characters, cannot be empty)
objectTypestringYesThe type of object the attribute belongs to. Must be either companies or deals.
optionsLabelsstring[]NoOptions for multi-choice or single-select attributes

brevo_crm_create_crm_deals

Create a deal Parameters:
ParameterTypeRequiredDefaultDescription
attributesobjectNoAttributes 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}
linkedCompaniesIdsstring[]NoCompany ids to be linked with deal
linkedContactsIdsinteger[]NoContact ids to be linked with deal
namestringYesName of deal

brevo_crm_create_crm_deals_import

Import deals(creation and updation) Parameters:
ParameterTypeRequiredDefaultDescription
filestringNoThe 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
mappingobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
contactIdintegerNoContact Id
dealIdstringNoDeal Id
filestringYesFile data to create a file.

brevo_crm_create_crm_notes

Create a note Parameters:
ParameterTypeRequiredDefaultDescription
companyIdsstring[]NoCompany Ids linked to a note
contactIdsinteger[]NoContact Ids linked to a note
dealIdsstring[]NoDeal Ids linked to a note
textstringYesContent 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:
ParameterTypeRequiredDefaultDescription
assignToIdstringNoTo assign a task to a user you can use either the account email or ID.
companiesIdsstring[]NoCompanies ids for companies a task is linked to
contactsIdsinteger[]NoContact ids for contacts linked to this task
datestringYesTask due date and time
dealsIdsstring[]NoDeal ids for deals a task is linked to
donebooleanNoTask marked as done
durationintegerNoDuration of task in milliseconds [1 minute = 60000 ms]
namestringYesName of task
notesstringNoNotes added to a task
reminderobjectNoTask reminder date/time for a task
taskTypeIdstringYesId for type of task e.g Call / Email / Meeting etc.

brevo_crm_delete_attributes_by_id

Delete an attribute Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAttribute ID

brevo_crm_delete_companies_by_id

Delete a company Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCompany ID to delete

brevo_crm_delete_deals_by_id

Delete a deal Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

brevo_crm_delete_files_by_id

Delete a file Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesFile id to delete.

brevo_crm_delete_notes_by_id

Delete a note Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesNote ID to delete

brevo_crm_delete_tasks_by_id

Delete a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

brevo_crm_get_companies_by_id

Get a company Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesGet Company Details

brevo_crm_get_deals_by_id

Get a deal Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

brevo_crm_get_files_by_id

Download a file Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesFile id to download.

brevo_crm_get_notes_by_id

Get a note Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesNote ID to get

brevo_crm_get_pipeline_details_by_pipeline_id

Get a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
pipelineIDstringYesPipeline ID

brevo_crm_get_tasks_by_id

Get a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

brevo_crm_list_companies

Get all Companies Parameters:
ParameterTypeRequiredDefaultDescription
filters[attributes.name]stringNoFilter 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.
linkedContactsIdsintegerNoFilter by linked contacts ids
linkedDealsIdsstringNoFilter by linked Deals ids
modifiedSincestringNoFilter (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.
createdSincestringNoFilter (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.
pageintegerNoIndex of the first document of the page
limitintegerNoNumber of documents per page
sortstringNoSort the results in the ascending/descending order. Default order is descending by creation if sort is not passed
sortBystringNoThe field used to sort field names.

brevo_crm_list_crm_attributes_companies

Get company attributes

brevo_crm_list_crm_attributes_deals

Get deal attributes

brevo_crm_list_crm_deals

Get all deals Parameters:
ParameterTypeRequiredDefaultDescription
filters[attributes.deal_name]stringNoFilter 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]stringNoFilter by linked companies ids
filters[linkedContactsIds]stringNoFilter by linked contacts ids
modifiedSincestringNoFilter (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.
createdSincestringNoFilter (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.
offsetintegerNoIndex of the first document of the page
limitintegerNoNumber of documents per page
sortstringNoSort the results in the ascending/descending order. Default order is descending by creation if sort is not passed
sortBystringNoThe field used to sort field names.

brevo_crm_list_crm_files

Get all files Parameters:
ParameterTypeRequiredDefaultDescription
entitystringNoFilter by file entity type
entityIdsstringNoFilter by file entity IDs
dateFromintegerNodateFrom to date range filter type (timestamp in milliseconds)
dateTointegerNodateTo to date range filter type (timestamp in milliseconds)
offsetintegerNoIndex of the first document of the page
limitintegerNoNumber of documents per page
sortstringNoSort 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:
ParameterTypeRequiredDefaultDescription
idstringYesFile id to get file data.

brevo_crm_list_crm_notes

Get all notes Parameters:
ParameterTypeRequiredDefaultDescription
entitystringNoFilter by note entity type
entityIdsstringNoFilter by note entity IDs
dateFromintegerNodateFrom to date range filter type (timestamp in milliseconds)
dateTointegerNodateTo to date range filter type (timestamp in milliseconds)
offsetintegerNoIndex of the first document of the page
limitintegerNoNumber of documents per page
sortstringNoSort 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 pipelines

brevo_crm_list_crm_tasks

Get all tasks Parameters:
ParameterTypeRequiredDefaultDescription
filter[type]stringNoFilter by task type (ID)
filter[status]stringNoFilter by task status
filter[date]stringNoFilter by date
filter[assignTo]stringNoFilter by the “assignTo” ID. You can utilize account emails for the “assignTo” attribute.
filter[contacts]stringNoFilter by contact ids
filter[deals]stringNoFilter by deals ids
filter[companies]stringNoFilter by companies ids
dateFromintegerNodateFrom to date range filter type (timestamp in milliseconds)
dateTointegerNodateTo to date range filter type (timestamp in milliseconds)
offsetintegerNoIndex of the first document of the page
limitintegerNoNumber of documents per page
sortstringNoSort the results in the ascending/descending order. Default order is descending by creation if sort is not passed
sortBystringNoThe field used to sort field names.

brevo_crm_list_crm_tasktypes

Get all task types

brevo_crm_update_companies_by_id

Update a company Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
attributesobjectNoAttributes for company update
countryCodeintegerNoCountry code if phone_number is passed in attributes.
linkedContactsIdsinteger[]NoWarning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
linkedDealsIdsstring[]NoWarning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed.
namestringNoName of company

Link and Unlink company with contact and deal Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
linkContactIdsinteger[]NoContact ids for contacts to be linked with company
linkDealsIdsstring[]NoDeal ids for deals to be linked with company
unlinkContactIdsinteger[]NoContact ids for contacts to be unlinked from company
unlinkDealsIdsstring[]NoDeal ids for deals to be unlinked from company

brevo_crm_update_crm_attributes_by_id

Update an attribute Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAttribute ID
labelstringNoAttribute display label
objectTypestringNoThe type of object the attribute belongs to, it cannot be updated after creation
optionsLabelsobject[]NoUpdated labels for selectable options

brevo_crm_update_crm_deals_by_id

Update a deal Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
attributesobjectNoAttributes 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}
linkedCompaniesIdsstring[]NoWarning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed.
linkedContactsIdsinteger[]NoWarning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
namestringNoName of deal

Link and Unlink a deal with contacts and companies Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
linkCompanyIdsstring[]NoCompany ids to be linked with deal
linkContactIdsinteger[]NoContact ids for contacts to be linked with deal
unlinkCompanyIdsstring[]NoCompany ids to be unlinked from deal
unlinkContactIdsinteger[]NoContact ids for contacts to be unlinked from deal

brevo_crm_update_crm_notes_by_id

Update a note Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesNote ID to update
companyIdsstring[]NoCompany Ids linked to a note
contactIdsinteger[]NoContact Ids linked to a note
dealIdsstring[]NoDeal Ids linked to a note
textstringYesContent 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
assignToIdstringNoTo assign a task to a user you can use either the account email or ID.
companiesIdsstring[]NoCompanies ids for companies a task is linked to
contactsIdsinteger[]NoContact ids for contacts linked to this task
datestringNoTask date/time
dealsIdsstring[]NoDeal ids for deals a task is linked to
donebooleanNoTask marked as done
durationintegerNoDuration of task in milliseconds [1 minute = 60000 ms]
namestringNoName of task
notesstringNoNotes added to a task
reminderobjectNoTask reminder date/time for a task
taskTypeIdstringNoId for type of task e.g Call / Email / Meeting etc.