> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # brevo-crm > Brevo CRM **Server path:** `/brevo-crm` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [`brevo_crm_create_companies`](#brevo_crm_create_companies) | Create a company | | [`brevo_crm_create_companies_import`](#brevo_crm_create_companies_import) | Import companies(creation and updation) | | [`brevo_crm_create_crm_attributes`](#brevo_crm_create_crm_attributes) | Create a company/deal attribute | | [`brevo_crm_create_crm_deals`](#brevo_crm_create_crm_deals) | Create a deal | | [`brevo_crm_create_crm_deals_import`](#brevo_crm_create_crm_deals_import) | Import deals(creation and updation) | | [`brevo_crm_create_crm_files`](#brevo_crm_create_crm_files) | Upload a file | | [`brevo_crm_create_crm_notes`](#brevo_crm_create_crm_notes) | Create a note | | [`brevo_crm_create_crm_tasks`](#brevo_crm_create_crm_tasks) | Create a task | | [`brevo_crm_delete_attributes_by_id`](#brevo_crm_delete_attributes_by_id) | Delete an attribute | | [`brevo_crm_delete_companies_by_id`](#brevo_crm_delete_companies_by_id) | Delete a company | | [`brevo_crm_delete_deals_by_id`](#brevo_crm_delete_deals_by_id) | Delete a deal | | [`brevo_crm_delete_files_by_id`](#brevo_crm_delete_files_by_id) | Delete a file | | [`brevo_crm_delete_notes_by_id`](#brevo_crm_delete_notes_by_id) | Delete a note | | [`brevo_crm_delete_tasks_by_id`](#brevo_crm_delete_tasks_by_id) | Delete a task | | [`brevo_crm_get_companies_by_id`](#brevo_crm_get_companies_by_id) | Get a company | | [`brevo_crm_get_deals_by_id`](#brevo_crm_get_deals_by_id) | Get a deal | | [`brevo_crm_get_files_by_id`](#brevo_crm_get_files_by_id) | Download a file | | [`brevo_crm_get_notes_by_id`](#brevo_crm_get_notes_by_id) | Get a note | | [`brevo_crm_get_pipeline_details_by_pipeline_id`](#brevo_crm_get_pipeline_details_by_pipeline_id) | Get a pipeline | | [`brevo_crm_get_tasks_by_id`](#brevo_crm_get_tasks_by_id) | Get a task | | [`brevo_crm_list_companies`](#brevo_crm_list_companies) | Get all Companies | | [`brevo_crm_list_crm_attributes_companies`](#brevo_crm_list_crm_attributes_companies) | Get company attributes | | [`brevo_crm_list_crm_attributes_deals`](#brevo_crm_list_crm_attributes_deals) | Get deal attributes | | [`brevo_crm_list_crm_deals`](#brevo_crm_list_crm_deals) | Get all deals | | [`brevo_crm_list_crm_files`](#brevo_crm_list_crm_files) | Get all files | | [`brevo_crm_list_crm_files_by_id_data`](#brevo_crm_list_crm_files_by_id_data) | Get file details | | [`brevo_crm_list_crm_notes`](#brevo_crm_list_crm_notes) | Get all notes | | [`brevo_crm_list_crm_pipeline_details_all`](#brevo_crm_list_crm_pipeline_details_all) | Get all pipelines | | [`brevo_crm_list_crm_tasks`](#brevo_crm_list_crm_tasks) | Get all tasks | | [`brevo_crm_list_crm_tasktypes`](#brevo_crm_list_crm_tasktypes) | Get all task types | | [`brevo_crm_update_companies_by_id`](#brevo_crm_update_companies_by_id) | Update a company | | [`brevo_crm_update_companies_link_unlink_by_id`](#brevo_crm_update_companies_link_unlink_by_id) | Link and Unlink company with contact and deal | | [`brevo_crm_update_crm_attributes_by_id`](#brevo_crm_update_crm_attributes_by_id) | Update an attribute | | [`brevo_crm_update_crm_deals_by_id`](#brevo_crm_update_crm_deals_by_id) | Update a deal | | [`brevo_crm_update_crm_deals_link_unlink_by_id`](#brevo_crm_update_crm_deals_link_unlink_by_id) | Link and Unlink a deal with contacts and companies | | [`brevo_crm_update_crm_notes_by_id`](#brevo_crm_update_crm_notes_by_id) | Update a note | | [`brevo_crm_update_crm_tasks_by_id`](#brevo_crm_update_crm_tasks_by_id) | Update a task | *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributes": { "type": "object", "description": "Attributes for company creation" }, "countryCode": { "type": "integer", "description": "Country code if phone_number is passed in attributes." }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids to be linked with company" }, "linkedDealsIds": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Deal ids to be linked with company" }, "name": { "type": "string", "description": "Name of company" } }, "required": [ "PCID", "name" ] } ``` *** ## 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 } ` | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file": { "type": "string", "description": "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": { "type": "object", "description": "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 } ```" } }, "required": [ "PCID" ] } ```` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributeType": { "type": "string", "description": "The type of attribute (must be one of the defined enums)", "enum": [ "text", "user", "number", "single-select", "date", "boolean", "multi-choice" ] }, "description": { "type": "string", "description": "A description of the attribute" }, "label": { "type": "string", "description": "The label for the attribute (max 50 characters, cannot be empty)" }, "objectType": { "type": "string", "description": "The type of object the attribute belongs to. Must be either `companies` or `deals`.", "enum": [ "companies", "deals" ] }, "optionsLabels": { "type": "array", "items": { "type": "string" }, "description": "Options for multi-choice or single-select attributes" } }, "required": [ "PCID", "attributeType", "label", "objectType" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributes": { "type": "object", "description": "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": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Company ids to be linked with deal" }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids to be linked with deal" }, "name": { "type": "string", "description": "Name of deal" } }, "required": [ "PCID", "name" ] } ``` *** ## 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 } ` | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file": { "type": "string", "description": "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": { "type": "object", "description": "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 } ```" } }, "required": [ "PCID" ] } ```` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "contactId": { "type": "integer", "description": "Contact Id" }, "dealId": { "type": "string", "description": "Deal Id" }, "file": { "type": "string", "description": "File data to create a file." } }, "required": [ "PCID", "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>`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyIds": { "type": "array", "items": { "type": "string" }, "description": "Company Ids linked to a note" }, "contactIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact Ids linked to a note" }, "dealIds": { "type": "array", "items": { "type": "string" }, "description": "Deal Ids linked to a note" }, "text": { "type": "string", "description": "Content of the note. Supports HTML for rich text formatting. Supported tags include: `

` (paragraph), `` / `` (bold), `` / `` (italic), `` (underline), `
` (line break), `` (labelled hyperlink). Example labelled link: `Link text`." } }, "required": [ "PCID", "text" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignToId": { "type": "string", "description": "To assign a task to a user you can use either the account email or ID." }, "companiesIds": { "type": "array", "items": { "type": "string" }, "description": "Companies ids for companies a task is linked to" }, "contactsIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact ids for contacts linked to this task" }, "date": { "type": "string", "description": "Task due date and time" }, "dealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals a task is linked to" }, "done": { "type": "boolean", "description": "Task marked as done" }, "duration": { "type": "integer", "description": "Duration of task in milliseconds [1 minute = 60000 ms]" }, "name": { "type": "string", "description": "Name of task" }, "notes": { "type": "string", "description": "Notes added to a task" }, "reminder": { "type": "object", "description": "Task reminder date/time for a task", "properties": { "types": { "type": "array", "items": { "type": "string", "enum": [ "email", "push" ] }, "description": "Type of task reminder e.g email, push" }, "unit": { "type": "string", "description": "Unit of time before reminder is to be sent", "enum": [ "minutes", "hours", "weeks", "days" ] }, "value": { "type": "integer", "description": "Value of time unit before reminder is to be sent" } }, "required": [ "value", "unit", "types" ] }, "taskTypeId": { "type": "string", "description": "Id for type of task e.g Call / Email / Meeting etc." } }, "required": [ "PCID", "date", "name", "taskTypeId" ] } ``` *** ## brevo\_crm\_delete\_attributes\_by\_id Delete an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | Attribute ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Attribute ID" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_companies\_by\_id Delete a company **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------- | | `id` | string | Yes | — | Company ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Company ID to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_deals\_by\_id Delete a deal **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_files\_by\_id Delete a file **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `id` | string | Yes | — | File id to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "File id to delete." } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_notes\_by\_id Delete a note **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------- | | `id` | string | Yes | — | Note ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Note ID to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_tasks\_by\_id Delete a task **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_companies\_by\_id Get a company **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------- | | `id` | string | Yes | — | Get Company Details | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Get Company Details" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_deals\_by\_id Get a deal **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_files\_by\_id Download a file **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------- | | `id` | string | Yes | — | File id to download. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "File id to download." } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_notes\_by\_id Get a note **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------- | | `id` | string | Yes | — | Note ID to get | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Note ID to get" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_pipeline\_details\_by\_pipeline\_id Get a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------- | | `pipelineID` | string | Yes | — | Pipeline ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pipelineID": { "type": "string", "description": "Pipeline ID" } }, "required": [ "PCID", "pipelineID" ] } ``` *** ## brevo\_crm\_get\_tasks\_by\_id Get a task **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filters[attributes.name]": { "type": "string", "description": "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": { "type": "integer", "description": "Filter by linked contacts ids" }, "linkedDealsIds": { "type": "string", "description": "Filter by linked Deals ids" }, "modifiedSince": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort field names." } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_attributes\_companies Get company attributes ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_attributes\_deals Get deal attributes ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filters[attributes.deal_name]": { "type": "string", "description": "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]": { "type": "string", "description": "Filter by linked companies ids" }, "filters[linkedContactsIds]": { "type": "string", "description": "Filter by linked contacts ids" }, "modifiedSince": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort field names." } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Filter by file entity type", "enum": [ "companies", "deals", "contacts" ] }, "entityIds": { "type": "string", "description": "Filter by file entity IDs" }, "dateFrom": { "type": "integer", "description": "dateFrom to date range filter type (timestamp in milliseconds)" }, "dateTo": { "type": "integer", "description": "dateTo to date range filter type (timestamp in milliseconds)" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "File id to get file data." } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Filter by note entity type", "enum": [ "companies", "deals", "contacts" ] }, "entityIds": { "type": "string", "description": "Filter by note entity IDs" }, "dateFrom": { "type": "integer", "description": "dateFrom to date range filter type (timestamp in milliseconds)" }, "dateTo": { "type": "integer", "description": "dateTo to date range filter type (timestamp in milliseconds)" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_pipeline\_details\_all Get all pipelines ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter[type]": { "type": "string", "description": "Filter by task type (ID)" }, "filter[status]": { "type": "string", "description": "Filter by task status", "enum": [ "done", "undone" ] }, "filter[date]": { "type": "string", "description": "Filter by date", "enum": [ "overdue", "today", "tomorrow", "week", "range" ] }, "filter[assignTo]": { "type": "string", "description": "Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute." }, "filter[contacts]": { "type": "string", "description": "Filter by contact ids" }, "filter[deals]": { "type": "string", "description": "Filter by deals ids" }, "filter[companies]": { "type": "string", "description": "Filter by companies ids" }, "dateFrom": { "type": "integer", "description": "dateFrom to date range filter type (timestamp in milliseconds)" }, "dateTo": { "type": "integer", "description": "dateTo to date range filter type (timestamp in milliseconds)" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort field names." } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_tasktypes Get all task types ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "attributes": { "type": "object", "description": "Attributes for company update" }, "countryCode": { "type": "integer", "description": "Country code if phone_number is passed in attributes." }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed." }, "linkedDealsIds": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Warning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed." }, "name": { "type": "string", "description": "Name of company" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "linkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be linked with company" }, "linkDealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals to be linked with company" }, "unlinkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be unlinked from company" }, "unlinkDealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals to be unlinked from company" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Attribute ID" }, "label": { "type": "string", "description": "Attribute display label" }, "objectType": { "type": "string", "description": "The type of object the attribute belongs to, it cannot be updated after creation", "enum": [ "companies", "deals" ] }, "optionsLabels": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Internal option identifier" }, "value": { "type": "string", "description": "Display label for the option" } }, "required": [ "key", "value" ] }, "description": "Updated labels for selectable options" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "attributes": { "type": "object", "description": "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": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed." }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed." }, "name": { "type": "string", "description": "Name of deal" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "linkCompanyIds": { "type": "array", "items": { "type": "string" }, "description": "Company ids to be linked with deal" }, "linkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be linked with deal" }, "unlinkCompanyIds": { "type": "array", "items": { "type": "string" }, "description": "Company ids to be unlinked from deal" }, "unlinkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be unlinked from deal" } }, "required": [ "PCID", "id" ] } ``` *** ## 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>`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Note ID to update" }, "companyIds": { "type": "array", "items": { "type": "string" }, "description": "Company Ids linked to a note" }, "contactIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact Ids linked to a note" }, "dealIds": { "type": "array", "items": { "type": "string" }, "description": "Deal Ids linked to a note" }, "text": { "type": "string", "description": "Content of the note. Supports HTML for rich text formatting. Supported tags include: `

` (paragraph), `` / `` (bold), `` / `` (italic), `` (underline), `
` (line break), `` (labelled hyperlink). Example labelled link: `Link text`." } }, "required": [ "PCID", "id", "text" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "assignToId": { "type": "string", "description": "To assign a task to a user you can use either the account email or ID." }, "companiesIds": { "type": "array", "items": { "type": "string" }, "description": "Companies ids for companies a task is linked to" }, "contactsIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact ids for contacts linked to this task" }, "date": { "type": "string", "description": "Task date/time" }, "dealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals a task is linked to" }, "done": { "type": "boolean", "description": "Task marked as done" }, "duration": { "type": "integer", "description": "Duration of task in milliseconds [1 minute = 60000 ms]" }, "name": { "type": "string", "description": "Name of task" }, "notes": { "type": "string", "description": "Notes added to a task" }, "reminder": { "type": "object", "description": "Task reminder date/time for a task", "properties": { "types": { "type": "array", "items": { "type": "string", "enum": [ "email", "push" ] }, "description": "Type of task reminder e.g email, push" }, "unit": { "type": "string", "description": "Unit of time before reminder is to be sent", "enum": [ "minutes", "hours", "weeks", "days" ] }, "value": { "type": "integer", "description": "Value of time unit before reminder is to be sent" } }, "required": [ "value", "unit", "types" ] }, "taskTypeId": { "type": "string", "description": "Id for type of task e.g Call / Email / Meeting etc." } }, "required": [ "PCID", "id" ] } ```