> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/companies/update-company.md).

# Update Company

Replace a company with the supplied fields.

Read Get Company first and preserve all values that should remain on the company record.

### Behaviour

Required fields and supplied arrays are authoritative: omit an optional array to clear it.

`currency` must be configured for your customer.

Requires the `companies:write` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"tags":[{"name":"Companies","description":"Manage the companies stored in your Mimeeq account. Company records hold business details, delivery addresses and commercial relationships, including assigned price lists.\n\nUse this section to synchronize company records with a CRM or ERP, retrieve company notes, and attach or detach price lists. People belonging to a company are managed through Contacts.\n\n## What you can do\n\n| Task | Reference |\n| --- | --- |\n| Find available companies | [List Companies](https://help.mimeeq.com/developers/companies/list-companies) |\n| Add a new company | [Create Company](https://help.mimeeq.com/developers/companies/create-company) |\n| Read one company | [Get Company](https://help.mimeeq.com/developers/companies/get-company) |\n| Change company | [Update Company](https://help.mimeeq.com/developers/companies/update-company) |\n| Find available company notes | [List Company Notes](https://help.mimeeq.com/developers/companies/list-company-notes) |\n| Change company price lists | [Update Company Price Lists](https://help.mimeeq.com/developers/companies/update-company-price-lists) |\n\n## Before you start\n\nYour API key needs `companies:read` to read these resources. Use `companies:write` for write operations.\n\n## Important behaviour\n\nRead Customer settings to obtain configured currency codes before creating or updating a company. General company updates replace the submitted configuration, and omitted optional arrays are cleared. Manage price-list assignments through their dedicated operation. Company deletion is not exposed by this API."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production API"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"CompaniesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."},"companyNumericId":{"type":"number"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManagerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManager":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"paymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveryAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","street","postcode","country","companyName","city"],"additionalProperties":false}},"socials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string"}},"required":["id","type","address"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contactId","firstName","lastName"],"additionalProperties":false}},"priceLists":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string"},"priceListName":{"type":"string"},"status":{"type":"string"}},"required":["priceListId","priceListName","status"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["companyId","companyNumericId","status","companyName","currency","address","email","workNumber","accountManagerId","accountManager","tags","paymentTerms","deliveryAddresses","socials","contacts","priceLists","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Company (GET /v1/companies/{companyId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"PublicError":{"description":"An API error response. Use code and the HTTP status to classify the failure, message and optional details for context, and requestId when reporting it. Edge firewall responses may omit requestId.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string","description":"Present on every error the API itself returns; absent when the edge firewall rejected the request."},"details":{"description":"Optional error-specific details (e.g. per-field validation reasons)."}}},"CompaniesCreateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string","minLength":1,"maxLength":255},"currency":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false},"email":{"type":"string","minLength":1,"maxLength":255},"workNumber":{"type":"string","minLength":1,"maxLength":255},"accountManagerId":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"tags":{"description":"Up to 50 tags.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"paymentTerms":{"type":"string","minLength":1,"maxLength":255},"deliveryAddresses":{"description":"Up to 50 delivery addresses.","maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"name":{"type":"string","minLength":1,"maxLength":255},"street":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255},"companyName":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false}},"socials":{"description":"Up to 20 socials.","maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string","minLength":1,"maxLength":255}},"required":["type","address"],"additionalProperties":false}}},"required":["status","companyName","currency"],"additionalProperties":false,"description":"Data schema used by Create Company (POST /v1/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}},"paths":{"/v1/companies/{companyId}":{"put":{"summary":"Update Company","tags":["Companies"],"description":"Replace a company with the supplied fields.\n\nRead Get Company first and preserve all values that should remain on the company record.\n\n## Behaviour\n\nRequired fields and supplied arrays are authoritative: omit an optional array to clear it.\n\n`currency` must be configured for your customer.\n\nRequires the `companies:write` scope.","responses":{"200":{"description":"Successful response.","headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesDetail"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"422":{"description":"Unprocessable entity (e.g. an unconfigured currency or quotation stage).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"429":{"description":"The API key exceeded its request rate (`rate_limit_exceeded`) or its monthly quota (`quota_exceeded`). Both carry `Retry-After`; the `RateLimit-*` headers accompany `rate_limit_exceeded` only, since a spent quota says nothing about the bucket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}}},"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesCreateRequest"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/companies/update-company.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.