PApax8
Companies

Update Company

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

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

Path parameters

companyIdstring uuid required
Example:f7fc273a-8d86-45c9-a26f-ffd42416adda

Request body

idstring uuid

The unique id of the company

namestring

The company name

phonestring

The primary phone number of the company

websitestring

The full URL of the company website

externalIdstring

An external ID that can be assigned to the company for reference

billOnBehalfOfEnabledboolean

Value is true if Pax8 handles billing transactions, value is false if partner handles billing transactions

selfServiceAllowedboolean

Value is true if self-service privileges are available to the company, otherwise value is false

orderApprovalRequiredboolean

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

Example request

{
  "name": "Pax8",
  "address": {
    "street": "5500 S Quebec St",
    "street2": "Ste. 350",
    "city": "Greenwood Village",
    "stateOrProvince": "CO",
    "postalCode": "80111",
    "country": "US"
  },
  "phone": "555-555-5555",
  "website": "https://www.pax8.com/"
}

Response

Successful Company update

idstring uuid

The unique id of the company

namestring required

The company name

phonestring required

The primary phone number of the company

websitestring required

The full URL of the company website

externalIdstring

An external ID that can be assigned to the company for reference

billOnBehalfOfEnabledboolean required

Value is true if Pax8 handles billing transactions, value is false if partner handles billing transactions

selfServiceAllowedboolean required

Value is true if self-service privileges are available to the company, otherwise value is false

orderApprovalRequiredboolean 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
updatedDatestring date-time

The date and time the company was last updated

Example response

{
  "name": "Pax8",
  "address": {
    "street": "5500 S Quebec St",
    "street2": "Ste. 350",
    "city": "Greenwood Village",
    "stateOrProvince": "CO",
    "postalCode": "80111",
    "country": "US"
  },
  "phone": "555-555-5555",
  "website": "https://www.pax8.com/",
  "contacts": [
    {
      "id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@doe.com",
      "phone": "555-555-5555",
      "createdDate": "2020-05-12"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.