---
title: "Update Company"
method: PATCH
path: "/companies/{companyId}"
tags: ["Companies"]
---

# Update Company

`PATCH /companies/{companyId}`

## Request

- Base URL: `https://api.pax8.com/v1`
- URL: `https://api.pax8.com/v1/companies/{companyId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://token-manager.pax8.com/oauth/token`

Updates an existing Company. ATTENTION - at least one parameter has to be modified.

## Path parameters

- `companyId` string, uuid, required

## Request body

- CompanyUpdate
  - `id` string, uuid: The unique id of the company
  - `name` string: The company name
  - `address` Address
    - `street` string: The primary street information
    - `street2` string: The secondary street information
    - `city` string: The city
    - `stateOrProvince` string: The state or province
    - `postalCode` string: The postal code
    - `country` string: The ISO 3166-1 alpha-2 code for the country
  - `phone` string: The primary phone number of the company
  - `website` string: The full URL of the company website
  - `externalId` string: An external ID that can be assigned to the company for reference
  - `billOnBehalfOfEnabled` boolean: Value is ```true``` if Pax8 handles billing transactions, value is ```false``` if partner handles billing transactions
  - `selfServiceAllowed` boolean: Value is ```true``` if self-service privileges are available to the company, otherwise value is ```false```
  - `orderApprovalRequired` boolean: Value is ```true``` if the company's self-service orders require approval, otherwise value is ```false```
  - `status` 'Active' | 'Inactive' | 'Deleted': Company Status: * `Active` - The company is active * `Inactive` - The company is inactive due to missing contacts * `Deleted` - The company has been deleted

## Response `200`

Successful Company update

- Company
  - `id` string, uuid: The unique id of the company
  - `name` string, required: The company name
  - `address` Address, required
    - `street` string: The primary street information
    - `street2` string: The secondary street information
    - `city` string: The city
    - `stateOrProvince` string: The state or province
    - `postalCode` string: The postal code
    - `country` string: The ISO 3166-1 alpha-2 code for the country
  - `phone` string, required: The primary phone number of the company
  - `website` string, required: The full URL of the company website
  - `externalId` string: An external ID that can be assigned to the company for reference
  - `billOnBehalfOfEnabled` boolean, required: Value is ```true``` if Pax8 handles billing transactions, value is ```false``` if partner handles billing transactions
  - `selfServiceAllowed` boolean, required: Value is ```true``` if self-service privileges are available to the company, otherwise value is ```false```
  - `orderApprovalRequired` boolean, required: Value is ```true``` if the company's self-service orders require approval, otherwise value is ```false```
  - `status` 'Active' | 'Inactive' | 'Deleted': Company Status: * `Active` - The company is active * `Inactive` - The company is inactive due to missing contacts * `Deleted` - The company has been deleted
  - `updatedDate` string, date-time: The date and time the company was last updated
  - `contacts` Contact[]: Optional array of contacts to create with the company. Including contacts during company creation will set the company status to "Active" immediately.
    - `id` string, uuid: The id
    - `firstName` string, required: The first name
    - `lastName` string, required: The last name
    - `email` string, email, required: The email
    - `phone` string, phone, required: The phone number
    - `createdDate` string: The created date
    - `types` ContactType[]
      - `type` 'Admin' | 'Billing' | 'Technical': A company must have a primary contact for each contact type. A single contact can be marked as a primary contact for all types Contact Type: * `Admin` - Administrative contact * `Billing` - Billing contact * `Technical` - Technical contact
      - `primary` boolean: Is this contact the primary contact for this Contact Type

## Other responses

- `422`: Invalid Company

---

[API](https://skmtc.dev/pax8/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/pax8/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/partner-endpoints/revisions/f90cec5b4720?raw)