Companies

Update a company

Updates a company. Every field is optional, and anything you leave out keeps its current value.

Note that domains adds rather than replaces — see the field for how to clear it.

patch/public-api/v1/companies/{id}

Request

Base URL
https://app.hellobonsai.com
URL
https://app.hellobonsai.com/public-api/v1/companies/{id}
Auth
- OAuth 2
  Authorization code: https://app.hellobonsai.com/oauth/authorize
  Token URL: https://app.hellobonsai.com/oauth/token
- or HTTP bearer

Path parameters

idinteger required

Id of the company to update.

Request body

Example request

{
  "company": {
    "name": "Acme Corp",
    "default_contact_id": 7,
    "description": "Long standing retainer client.",
    "industry": "computers_electronics_and_technology",
    "company_size": "size_201_1000",
    "source": "organic_search",
    "linkedin": "https://linkedin.com/company/acme",
    "instagram": "https://instagram.com/acme",
    "twitter": "https://x.com/acme",
    "facebook": "https://facebook.com/acme",
    "domains": [
      "example.net"
    ]
  }
}

Response

The company was updated.

Example response

{
  "data": {
    "id": 42,
    "name": "Acme Corp",
    "default_contact_id": 7,
    "description": "Long standing retainer client.",
    "industry": "computers_electronics_and_technology",
    "company_size": "size_201_1000",
    "source": "organic_search",
    "linkedin": "https://linkedin.com/company/acme",
    "instagram": "https://instagram.com/acme",
    "twitter": "https://x.com/acme",
    "facebook": "https://facebook.com/acme",
    "archived_at": "2026-04-14T09:12:04.000Z",
    "created_at": "2026-04-14T09:12:04.000Z",
    "domains": [
      "example.com",
      "example.net"
    ],
    "avatar_url": "https://logo.clearbit.com/acme.com",
    "url": "https://app.hellobonsai.com/companies/42"
  },
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.