Update company - TalkToHumans

PATCH

https://api.talktohumans.app

/

v1

/

companies

/

{company_id}

curl --request PATCH \
  --url https://api.talktohumans.app/v1/companies/{company_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "42",
  "Deal stage": "Negotiation",
  "ARR": 50000
}
'

{
  "data": {
    "company": {
      "company_id": "<string>",
      "provider_participant_id": "<string>",
      "name": "<string>",
      "industries": [
        {
          "name": "<string>",
          "title": "<string>",
          "industry_urn": "<string>",
          "provider_industry_id": "<string>",
          "hierarchy": "<string>"
        }
      ],
      "locations": [
        {
          "is_primary": true,
          "is_headquarter": true,
          "linkedin_text": "<string>",
          "display_text": "<string>",
          "country_code": "<string>",
          "region_code": "<string>",
          "country": "<string>",
          "country_full": "<string>",
          "state": "<string>",
          "city": "<string>",
          "geographic_area": "<string>"
        }
      ],
      "public_identifier": "<string>",
      "headline": "<string>",
      "linkedin_url": "<string>",
      "avatar_url": "<string>",
      "background_cover_url": "<string>",
      "headcount": "<string>",
      "employee_count": 123,
      "founding_date": "<string>",
      "website_url": "<string>",
      "follower_count": 123,
      "about": "<string>",
      "notes_json": "<string>",
      "tags": [
        {
          "name": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Pass API key as Authorization: Bearer <api_key>.

Path Parameters

company_id

string

required

Company ID returned by GET /v1/companies (the company_id field).

Pattern: ^[1-9][0-9]*$

Body

application/json

Company update payload. Known system keys are documented below. Any additional top-level key is treated as a registered company custom field key, following the same convention as the contact update endpoint. Unknown custom field keys, keys that collide with system fields, and values that do not match the registered field type are rejected.

account_id

string

LinkedIn account ID returned by GET /v1/accounts. Required to write notes and when the company exists under multiple LinkedIn accounts.

Pattern: ^[1-9][0-9]*$

tags

object

Use set for exact replacement, or add/remove for incremental updates. set cannot be combined with add or remove.

Show child attributes

notes_json

string | null

Text to store as notes. Use null or an empty string to clear notes.

{key}

Value for a registered custom field key. Use null to clear. Date fields must use YYYY-MM-DD strings.

Response

Company updated.

data

object

required

Show child attributes

curl --request PATCH \
  --url https://api.talktohumans.app/v1/companies/{company_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "42",
  "Deal stage": "Negotiation",
  "ARR": 50000
}
'

{
  "data": {
    "company": {
      "company_id": "<string>",
      "provider_participant_id": "<string>",
      "name": "<string>",
      "industries": [
        {
          "name": "<string>",
          "title": "<string>",
          "industry_urn": "<string>",
          "provider_industry_id": "<string>",
          "hierarchy": "<string>"
        }
      ],
      "locations": [
        {
          "is_primary": true,
          "is_headquarter": true,
          "linkedin_text": "<string>",
          "display_text": "<string>",
          "country_code": "<string>",
          "region_code": "<string>",
          "country": "<string>",
          "country_full": "<string>",
          "state": "<string>",
          "city": "<string>",
          "geographic_area": "<string>"
        }
      ],
      "public_identifier": "<string>",
      "headline": "<string>",
      "linkedin_url": "<string>",
      "avatar_url": "<string>",
      "background_cover_url": "<string>",
      "headcount": "<string>",
      "employee_count": 123,
      "founding_date": "<string>",
      "website_url": "<string>",
      "follower_count": 123,
      "about": "<string>",
      "notes_json": "<string>",
      "tags": [
        {
          "name": "<string>"
        }
      ]
    }
  }
}