v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Company

Lets you update details of a company.

put/companies

Query parameters

externalIdstring

External ID of the company.

idinteger

Unique ID of the company.

Request body

namestring

New name of the company.

Response

200

externalIdstring

companyIdinteger

namestring

hierarchyDefinitionCodestring

isActiveboolean

warningsobject[]

Example response

{
  "externalId": "Purple2345",
  "companyId": 98,
  "name": "Purple US",
  "hierarchyDefinitionCode": "code-association2",
  "isActive": true,
  "extendedFields": {
    "address1": "Hill Town",
    "address2": "US",
    "address3": "UK",
    "address4": "Paris",
    "company_city": "VC",
    "company_country": "India",
    "company_state": "Karnataka",
    "owner": "James",
    "phone": "9870000000",
    "pincode": "560068"
  }
}