PATCH
/
companies
/
{id}
curl --request PATCH \
  --url https://commerce.driv.ly/api/companies/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "com_9j3k2dls0j29",
  "name": "Auto Sales Co.",
  "address": "123 Main St, Anytown, USA",
  "locations": [
    {
      "id": "loc_k2j3l9s9d4j0",
      "companyId": "com_9j3k2dls0j29",
      "address": "123 Main St, Anytown, USA",
      "phone": "+1234567890"
    }
  ]
}'
{
  "data": {
    "id": "com_9j3k2dls0j29",
    "name": "Auto Sales Co.",
    "address": "123 Main St, Anytown, USA",
    "locations": [
      {
        "id": "loc_k2j3l9s9d4j0",
        "companyId": "com_9j3k2dls0j29",
        "address": "123 Main St, Anytown, USA",
        "phone": "+1234567890"
      }
    ]
  },
  "success": true
}

Path Parameters

​
id
string
required

Customer is uniquely identified by id

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Body

application/json

Response

200
application/json

Company Updated

The response is of type object.