v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Remove Company

Lets you delete an existing company. The company and its associated sub-companies will go inactive. However, the customers associated with the company will still remain active.

delete/companies

Query parameters

externalIdstring

External ID of the company.

idinteger

Unique ID of the company.

Response

200

externalIdstring
companyIdinteger
namestring
hierarchyDefinitionCodestring
isActiveboolean

Example response

{
  "externalId": "ex-97608521",
  "companyId": 41,
  "name": "name-97608521",
  "hierarchyDefinitionCode": "code-tst1111",
  "extendedFields": {
    "address1": "Lal Chowk",
    "company_city": "Delhi",
    "company_country": "India",
    "company_state": "Delhi",
    "industry": "industry1",
    "owner": "Kim",
    "phone": "9081000000",
    "pincode": "410093"
  }
}