API Reference

Create Company

post
https://api.pax8.com/v1/companies

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".

Recipes
⚙️
Onboarding a New Company
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Company object

string
required

The company name

address
object
required
string
required

The primary phone number of the company

string
required

The full URL of the company website

string

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

boolean
required

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

boolean
required

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

boolean
required

Value is true if the company's self-service orders require approval, otherwise value is false

contacts
array of objects

Optional array of contacts to create with the company. Including contacts during company creation will set the company status to "Active" immediately.

contacts
Responses

Updated about 1 month ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago