v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Companies

Update a company

patch/companies/{id}

Path parameters

idstring required

Request body

namestring

Name of company

attributesobject

Attributes for company update

countryCodeinteger

Country code if phone_number is passed in attributes.

Example request

{
  "name": "company",
  "attributes": {
    "category": "label_2",
    "domain": "xyz",
    "date": "2022-05-04T00:00:00+05:30",
    "industry": "flipkart",
    "number_of_contacts": 1,
    "number_of_employees": 100,
    "owner": "5b1a17d914b73d35a76ca0c7",
    "phone_number": "81718441912",
    "revenue": 10000.34222
  },
  "countryCode": 91
}

Response

Company updated successfully

idstring

Unique company id

attributesobject

Company attributes with values

linkedContactsIdsinteger[]

Contact ids for contacts linked to this company

linkedDealsIdsstring[]

Deals ids for companies linked to this company

Example response

{
  "linkedDealsIds": [
    "61a5ce58c5d4795761045990",
    "61a5ce58c5d4795761045991",
    "61a5ce58c5d4795761045992"
  ],
  "linkedContactsIds": [
    1,
    2,
    3
  ],
  "attributes": {
    "created_at": "2022-01-13T19:04:24.376+05:30",
    "domain": "xyz",
    "last_updated_at": "2022-04-01T18:47:48.283+05:30",
    "name": "text",
    "number_of_contacts": 0,
    "owner": "62260474111b1101704a9d85",
    "owner_assign_date": "2022-04-01T18:21:13.379+05:30",
    "phone_number": 8171844192,
    "revenue": 10
  },
  "id": "629475917295261d9b1f4403"
}