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

# Update a company

`PATCH /companies/{id}`

**Plan: Paid API.**

## Request body

- CompanyWrite — Create/update payload wrapped under `company`, using `snake_case`. Nested collections use Rails `*_attributes` arrays; pass `_destroy: true` to remove a nested address, email or phone (nested contacts do not accept `_destroy`). The most common writable fields are listed below; additional company attributes are also accepted.
  - `company` object, required
    - `name` string, required
    - `legal_name` string
    - `posted` boolean
    - `taxable` boolean
    - `status` string
    - `legacy_type` string
    - `primary_email` string
    - `primary_phone` string
    - `primary_phone_ext` string
    - `website` string
    - `discount` number
    - `credit_limit_in_dollars` number
    - `term_code_id` string, uuid
    - `category_id` string, uuid
    - `lead_source_id` string, uuid
    - `pricing_level_id` string, uuid
    - `primary_contact_id` string, uuid
    - `account_number` string
    - `tax_exempt_code` string
    - `tax_exempt_expiration_date` string, date
    - `sales_tax_id` string, uuid
    - `sales_tax_name` string
    - `enable_customer_portal` boolean
    - `enable_job_board_view` boolean
    - `enable_customer_portal_ordering` boolean
    - `enable_web_store` boolean
    - `term_code_name` string
    - `category_name` string
    - `lead_source_name` string
    - `pricing_level_name` string
    - `marketing_area_id` string, uuid
    - `marketing_area_name` string
    - `primary_contact_name` string
    - `ap_contact_id` string, uuid
    - `group_id` string, uuid
    - `group_name` string
    - `division_name` string
    - `do_not_call` boolean
    - `stop_supply` boolean
    - `facebook` string
    - `twitter` string
    - `other_info` string
    - `special_notes` string
    - `licence_number` string
    - `toll_free_number` string
    - `background_info` string
    - `local_file_path` string
    - `contacts_attributes` NestedContactWrite[]
      - `id` string, uuid
      - `name` string
      - `title` string
      - `email` string
      - `phone` string
      - `ext` string
      - `company_id` string, uuid
    - `addresses_attributes` NestedAddressWrite[]
      - `id` string
      - `address_type` string
      - `name` string
      - `street` string
      - `street1` string
      - `suburb` string
      - `city` string
      - `state` string
      - `zip` string
      - `country` string
      - `attention_to` string
      - `zip_from_foreign_country` string — Contacts only.
      - `_destroy` boolean
    - `emails_attributes` NestedEmailWrite[]
      - `id` string
      - `email` string
      - `email_type` string
      - `_destroy` boolean
    - `phones_attributes` NestedPhoneWrite[]
      - `id` string
      - `phone` string
      - `phone_type` string
      - `ext` string
      - `_destroy` boolean
    - `company_sales_reps_attributes` object[] — Assign sales reps to the company.
      - `id` string, uuid
      - `user_id` string, uuid
      - `company_id` string, uuid

## Response `200`

Updated.

- Company — Full company as returned by show/create/update. `createdAt`/`updatedAt` here are localized display strings, unlike the ISO timestamps on the list endpoint.
  - `id` string, uuid
  - `accountId` string, uuid
  - `name` string
  - `legalName` string, nullable
  - `status` string, nullable
  - `active` boolean
  - `posted` boolean
  - `taxable` boolean
  - `legacyType` string, nullable — e.g. Customer, Vendor.
  - `primaryEmail` string, nullable
  - `primaryPhone` string, nullable
  - `primaryPhoneExt` string, nullable
  - `phoneWithExt` string, nullable
  - `website` string, nullable
  - `facebook` string, nullable
  - `twitter` string, nullable
  - `creditLimitInDollars` number, nullable — US dollars.
  - `discount` number, nullable
  - `markup` number, nullable
  - `currency` string, nullable
  - `currencySymbol` string, nullable
  - `rate` number, nullable
  - `accountNumber` string, nullable
  - `licenceNumber` string, nullable
  - `tollFreeNumber` string, nullable
  - `taxExemptCode` string, nullable
  - `taxExemptExpirationDate` string, date, nullable
  - `backgroundInfo` string, nullable
  - `otherInfo` string, nullable
  - `specialNotes` string, nullable
  - `localFilePath` string, nullable
  - `doNotCall` boolean
  - `stopSupply` boolean
  - `enableCustomerPortal` boolean
  - `enableJobBoardView` boolean
  - `enableCustomerPortalOrdering` boolean
  - `enableWebStore` boolean
  - `notesCount` integer
  - `assetsCount` integer
  - `tasksCount` integer
  - `allowDelete` boolean
  - `termCodeId` string, uuid, nullable
  - `termCodeName` string, nullable
  - `salesTaxId` string, uuid, nullable
  - `leadSourceId` string, uuid, nullable
  - `leadSourceName` string, nullable
  - `categoryName` string, nullable
  - `pricingLevelId` string, uuid, nullable
  - `pricingLevelName` string, nullable
  - `primaryContactId` string, uuid, nullable
  - `apContactId` string, uuid, nullable
  - `createdById` string, uuid, nullable
  - `updatedById` string, uuid, nullable
  - `createdAt` string
  - `updatedAt` string
  - `primaryContact` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `apContact` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `leadSource` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `marketingArea` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `group` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `category` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `pricingLevel` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `createdBy` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `updatedBy` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `tax` object
    - `id` string, uuid
    - `name` string
    - `rate` number
    - `taxRate` number
    - `rateInPercent` string
  - `salesReps` Party[]
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `companySalesReps` object[]
    - `companySalesRepId` string, uuid
    - `companyId` string, uuid
    - `id` string, uuid — User id.
    - `accountId` string, uuid
    - `name` string, nullable
  - `contacts` object[]
    - `id` string, uuid
    - `name` string
    - `title` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `ext` string, nullable
    - `phoneWithExt` string, nullable
  - `addresses` Address[]
    - `id` string
    - `addressType` string, nullable
    - `name` string, nullable
    - `nameStreet` string, nullable
    - `nameStreetCity` string, nullable
    - `street` string, nullable
    - `street1` string, nullable
    - `suburb` string, nullable
    - `city` string, nullable
    - `zip` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `attentionTo` string, nullable
    - `coordinates` object
      - `latitude` number, nullable
      - `longitude` number, nullable
  - `emails` Email[]
    - `id` string
    - `email` string
    - `emailType` string, nullable
  - `phones` Phone[]
    - `id` string
    - `phone` string
    - `ext` string, nullable
    - `phoneType` string, nullable
    - `phoneWithExt` string, nullable
  - `companyDivisionsTitle` string, nullable
  - `companyDivisions` NamedRef[]
    - `id` string, uuid
    - `name` string

## Other responses

- `422` — Unprocessable entity - field errors keyed by attribute.

---

[API](https://skmtc.net/shopvox/apis/shopvox-public-api.md) · [All operations](https://skmtc.net/shopvox/apis/shopvox-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopvox/shopvox-public-api/revisions/7ac1ff5d444a/schema)