v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Company

Lets you add a new company to the org.

post/companies

Request body

namestring required

Name of the company,

externalIdstring required

External ID of the company.

hierarchyDefinitionCodestring required

Unique code of the hierarchy applicable for the company. You can use only from hierarchies that are configured for the org.

Response

200

externalIdstring

companyIdinteger

namestring

hierarchyDefinitionCodestring

warningsobject[]

Example response

{
  "externalId": "Purple2345",
  "companyId": 98,
  "name": "Purple Distributors",
  "hierarchyDefinitionCode": "code-association2",
  "extendedFields": {
    "address1": "Temple Street, X Road",
    "company_city": "Bangalore",
    "company_country": "India",
    "company_state": "Karnataka",
    "owner": "Capillary",
    "phone": "919900000000",
    "pincode": "560068"
  }
}