Update a company | Brevo API Documentation

1 import requests 2 3 url = "https://api.brevo.com/v3/companies/id" 4 5 payload = {} 6 headers = { 7 "api-key": "<apiKey>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.patch(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "attributes": { 3 "created_at": "2022-01-13T19:04:24.376+05:30", 4 "domain": "xyz", 5 "last_updated_at": "2022-04-01T18:47:48.283+05:30", 6 "name": "text", 7 "number_of_contacts": 0, 8 "owner": "62260474111b1101704a9d85", 9 "owner_assign_date": "2022-04-01T18:21:13.379+05:30", 10 "phone_number": 8171844192, 11 "revenue": 10 12 }, 13 "id": "629475917295261d9b1f4403", 14 "linkedContactsIds": [ 15 1, 16 2, 17 3 18 ], 19 "linkedDealsIds": [ 20 "61a5ce58c5d4795761045990", 21 "61a5ce58c5d4795761045991", 22 "61a5ce58c5d4795761045992" 23 ] 24 }

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

idstringRequired

Request

Updated company details.

attributesobjectOptional

Attributes for company update

countryCodelongOptional

Country code if phone_number is passed in attributes.

linkedContactsIdslist of longsOptional

Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.

linkedDealsIdslist of stringsOptional

Warning - Using PATCH on linkedDealsIds replaces the list of linked contacts. Omitted IDs will be removed.

namestringOptional

Name of company

Response

Company updated successfully

attributesobject or null

Company attributes with values

idstring or null

Unique company id

linkedContactsIdslist of integers or null

Contact ids for contacts linked to this company

linkedDealsIdslist of strings or null

Deals ids for companies linked to this company

Authentication

Path parameters

Request

Response

Errors