Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <credential>, where the credential is either:

  • an API key (sk_…), generated by an organization admin in Settings, for scripts and automation;
  • an access token from tth auth login (the TalkToHumans CLI), which any member of the workspace can use.

Both resolve to the same organization and user. A login token acts in the user's workspace: one with no workspace yet returns 403 workspace_setup_required, and one in several workspaces returns 403 forbidden (use an API key instead).

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, including tags and notes, 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. Provide at least one of tags, notes, or a custom field key.

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.

notes
object

Use set for exact replacement, or add/remove for incremental updates. set cannot be combined with add or remove. A contact or company can have at most 20 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