Ventia
Company groups

Update a company

Updates a company (company group). Only the sent fields are modified. Keys sent inside `additionalData` are merged with the stored ones, so the additional fields that are not sent keep their value.

PATCH
/company-groups/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key sent as Authorization: Bearer <API_KEY>.

Path Parameters

id*string

Unique identifier of the company.

Request Body

application/json
  1. body
businessName?string

Legal name of the company. Always required on creation.

Length1 <= length
displayName?string

Commercial name of the company. Required on creation unless the company disables mandatory fields or hides the field.

description?string

Free text description.

origin?string

Origin of the company. Defaults to API Pública.

taxCode?string

Tax identification (RUT / CUIT / NIT depending on the country). Must be unique inside your company. Required on creation unless the company disables mandatory fields or hides the field.

direction?

Physical address of the company.

sectors?boolean

Enables sectors for this company.

status?string

Defaults to active.

Value in"active""inactive"
additionalData?

Values for the additional company fields configured on the company. Every key must match the code of an active additional company field, otherwise the request is rejected. Values are validated against the type of the field: string, number, date (ISO 8601), select (one of the configured options), multiselect (array of configured options), phonenumbers (array of valid phone numbers), selectcontact / selectcompany (id of a contact / company of your company) and multiplecontact / multiplecompany (array of those ids). Fields marked as required must be sent on creation, and fields marked as unique cannot repeat a value already used by another company.

Response Body

Company updated successfully

application/json
curl -X PATCH 'https://api.getventia.com/api/v1.0/company-groups/67bca48d5fc32659c854f83c' \  -H 'Content-Type: application/json' \  -d '{  "displayName": "Ventia CRM",  "status": "inactive",  "additionalData": {    "employees": 150  }}'
{  "_id": "67bca48d5fc32659c854f83c",  "displayName": "Ventia",  "businessName": "Ventia S.A.",  "description": "CRM provider",  "origin": "API Pública",  "taxCode": "218765430017",  "direction": {    "location": true,    "route": "Av. Italia",    "street_number": "6201",    "locality": "Montevideo",    "country": "Uruguay",    "formatted_address": "Av. Italia 6201, Montevideo, Uruguay",    "place_id": "ChIJXXXXXXXXXXXXXXXXXXXX",    "geoLocation": {      "type": "Point",      "coordinates": [        -56.1645,        -34.8836      ]    }  },  "sectors": false,  "status": "active",  "additionalData": {    "industry": "Software",    "employees": 120  },  "company": "5f2b1c8e9f1b4a0017a1b2c3",  "createdBy": "61a5f9d6c4e2b30017c9d123",  "createdAt": "2026-02-24T18:21:01.000Z",  "updatedAt": "2026-02-24T18:21:01.000Z"}