companies.update
Edit a company
- Request
- PATCH
/api/v1/companies/{companyId} - Scope required
companies:write- Effect
- Changes data. Send an Idempotency-Key if you might retry it.
- Acts on
- Acts on the account’s own job search.
- MCP tool
companies_update- Environment
- Live and sandbox alike.
- Request body
- JSON.
What it does
Changes an employer's name or profile. A field you leave out keeps its current value; sending `null` clears one. The change is visible on every application filed against this company, so renaming it here renames it across the whole board rather than only on one card. Send the `ETag` from `companies.get` as `If-Match` to be refused with 412 if it changed in between.
Parameters
| Name | Sent in | Requirement | Accepts |
|---|---|---|---|
| companyId | path | Required | string |
| If-Match | header | Optional | string — The ETag of the version you read. The write is refused with 412 if the resource has changed since. |
Request body
- industry
- one of: agriculture, arts, automotive, banking, biotechnology, chemical, communications, construction, consulting, education, electronics, energy, engineering, entertainment, environmental, finance, food, government, healthcare, hospitality, insurance, legal, manufacturing, media, non_profit, pharmaceutical, real_estate, retail, software, sports, technology, telecommunications, transportation, travel, other, unknown, optional
- string or null, optional
- name
- string, optional
- notes
- string or null, optional
- size
- one of: tiny, small, medium, large, massive or null, optional
- type
- one of: government_agency, non_profit, private, public or null, optional
- website
- string or null, optional
Response
- applicationCount
- integer, required
- createdAt
- string, required
- id
- string, required
- industry
- one of: agriculture, arts, automotive, banking, biotechnology, chemical, communications, construction, consulting, education, electronics, energy, engineering, entertainment, environmental, finance, food, government, healthcare, hospitality, insurance, legal, manufacturing, media, non_profit, pharmaceutical, real_estate, retail, software, sports, technology, telecommunications, transportation, travel, other, unknown, required
- string or null, required
- name
- string, required
- notes
- string or null, required
- size
- one of: tiny, small, medium, large, massive or null, required
- type
- one of: government_agency, non_profit, private, public or null, required
- updatedAt
- string, required
- website
- string or null, required
Examples
Record what the company actually does
curl -s -X PATCH https://www.jobapplicationtracking.com/api/v1/companies/co_42 \
-H "Authorization: Bearer $JAT_KEY" \
-H "Content-Type: application/json" \
-d '{
"industry": "software",
"size": "medium"
}'{
"id": "co_42",
"name": "Northwind",
"industry": "software",
"size": "medium",
"type": "private",
"website": "https://northwind.example",
"linkedin": null,
"notes": null,
"applicationCount": 3,
"createdAt": "2026-01-04T09:30:00.000Z",
"updatedAt": "2026-02-11T17:05:00.000Z"
}