Skip to main content
PATCH
Update company

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Company sid (cr_co_…).

Required string length: 18
Pattern: ^cr_co_

Body

application/json

Request body of update_company.

name
string | null

A manual observation that outranks every source until reset; the linked people show it (their items, documents and templates resolve it).

Required string length: 1 - 511
logo_url
string<uri> | null

New logo URL (max 2048), a manual observation; null records a manual none (the domain favicon).

Maximum string length: 2048
ln_id
string | null

Identity edit - a collision with another live account flags this row status=duplicate (never a 409); the linked people's documents follow.

Maximum string length: 255
ln_nickname
string | null

Identity edit - dedup guard re-runs; a page URL is reduced to the slug in place.

Maximum string length: 255
website
string<uri> | null

The full URL, a manual observation; domain is not derived on update.

Maximum string length: 511
domain
string | null

Identity edit - dedup guard re-runs; normalized in place.

Maximum string length: 255
deal_size
number | null

Deal value (decimal 15,2); null clears it.

tag_sids
string[] | null

Full-replace (not a merge).

Required string length: 18
Pattern: ^cr_tg_
external_refs
object | null

Free-form CRM sync hook, full-replace; round-tripped as-is.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.