Companies

Create Company

Creates a new company. You can optionally include contacts in the request body to create the company with contacts in a single request. If no contacts are provided, the company will be placed in an "inactive" status until the company has primary contacts added. Once contacts are added, the company will move to "Active".

post/companies

Request

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

Request body

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 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/",
  "contacts": [
    {
      "id": "18d6329e-93f9-46a5-9df7-37e4c29d2840",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@doe.com",
      "phone": "555-555-5555",
      "createdDate": "2020-05-12"
    }
  ]
}

Response

Successful Company create