SparrowDesk
Companies

Update a company

PATCH
/companies/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idinteger

Unique identifier of the company

Request Body

At least one field must be provided

name?string
domain?string

Lowercase domain like example.com or company.co.uk

phone?string
address?string
notes?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.sparrowdesk.com/v1/companies/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": 0,
    "name": "string",
    "domain": "string",
    "logo": "string",
    "industry": "string",
    "phone": "string",
    "address": "string",
    "notes": "string",
    "other_details": {},
    "total_contacts_linked": 0,
    "created_at": 0,
    "updated_at": 0
  }
}
{
  "error": {
    "message": "At least one field must be provided"
  }
}
{
  "error": {
    "message": "Company not found"
  }
}
{
  "error": {
    "message": "Company with this name already exists"
  }
}
{
  "error": {
    "message": "Error while updating company"
  }
}