---
title: "Update a company"
method: PATCH
path: "/companies/{id}"
tags: ["Companies"]
---

# Update a company

`PATCH /companies/{id}`

## Request

- Base URL: `https://joinways.app/api/v1`
- URL: `https://joinways.app/api/v1/companies/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://joinways.app/oauth/authorize`, token URL `https://joinways.app/api/oauth/token`, scopes: `mcp.write`)

Updates the given fields; changes of name, website, city and country are written to the timeline. **Role permission:** `data.write`.

## Headers

- `Idempotency-Key` string

## Request body

- CompanyUpdate: Every field is optional; at least one is required.
  - `name` string
  - `website` string
  - `phone` string
  - `registration_number` string
  - `siret` string: Alias of `registration_number`.
  - `vat_number` string
  - `address` string
  - `city` string
  - `postal_code` string
  - `state` string
  - `country` string

## Response `200`

The updated company.

- CompanyDetail: A client company of the CRM.
  - `id` string, uuid
  - `name` string
  - `registration_number` string, nullable: Company registration number (e.g. SIRET).
  - `vat_number` string, nullable: VAT / tax identifier.
  - `website` string, nullable
  - `phone` string, nullable
  - `address` string, nullable
  - `city` string, nullable
  - `postal_code` string, nullable
  - `state` string, nullable: State / province / region (US state, Canadian province…).
  - `country` string, nullable
  - `enrichment_status` string, nullable: Automatic enrichment of the company profile.
  - `enrichment_completed_at` string, date-time, nullable
  - `created_at` string, date-time, nullable
  - `updated_at` string, date-time, nullable
  - `account_id` string, uuid
  - `notes` string, nullable
  - `source` string, nullable
  - `source_metadata` object, nullable
  - `external_id` string, nullable
  - `enrichment_data` object, nullable: What the enrichment found (website, size, sector…).
  - `enrichment_error` string, nullable
  - `enrichment_started_at` string, date-time, nullable

## Other responses

- `400`: Validation failed (`invalid_request`). For a body that fails the schema, `details` holds `formErrors` and `fieldErrors`.
- `401`: Missing, invalid, expired or revoked bearer token (`unauthorized`).
- `403`: `forbidden`: the token lacks the scope, its owner's role lacks the permission named by the operation, or the workspace has neither the Pro plan nor a trial (`details.reason` `plan_not_eligible`).
- `404`: Not found in this workspace, or the id of the path is not a UUID (`not_found`).
- `409`: The state of the record refuses the operation (`conflict`). `details.reason` is a stable code.
- `429`: Too many requests (`rate_limited`). `details.reason`: `per-ip`, `per-account-minute`, `per-account-day`, or `email_rate_limited` (email budget). Always carries `Retry-After`: wait that many seconds.

---

[API](https://skmtc.dev/joinways/apis/joinways-public-api.md) · [All operations](https://skmtc.dev/joinways/apis/joinways-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/joinways/apis/joinways-public-api/revisions/39e84309953e?raw)