Update Company

PATCH

/companies/{company_id}

• Production
• QA

Update a company’s fields (partial update).

A name over 512 characters or a linkedin_url that is not a web address is refused with a 400 and nothing is written. An employee_count with no number, an unrecognised country, or a linkedin_url that is not on linkedin.com is saved as sent and flagged in warnings (present only when there is something to flag).

Authorizations

• BearerAuth

Parameters

Path Parameters

company_id

required

Company ID

integer

Company ID

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Request body for updating a company. All fields optional (partial update).

object

address

Any of:

string

string

null

null

city

Any of:

string

string

null

null

country

Any of:

string

string

null

null

domain

Any of:

string

string

null

null

employee_count

Any of:

string

string

null

null

industry

Any of:

string

string

null

null

linkedin_url

Any of:

string

string

null

null

name

Any of:

string

string

null

null

phone

Any of:

string

string

null

null

state

Any of:

string

string

null

null

website

Any of:

string

string

null

null

zip

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string