Create a new Client

post

https://api.servicem8.com/api_1.0/company.json

OAuth Scope

This endpoint requires the following OAuth scope manage_customers.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Client record to create

name

string

required

length ≤ 100

Company Name

abn_number

string

Australian Business Number. A unique 11-digit identifier issued by the Australian Taxation Office to businesses. Required for tax compliance and validation of business identity in Australia.

address

string

length ≤ 500

Password

billing_address

string

length ≤ 500

Confirm Password

parent_company_uuid

string

If provided, specifies the UUID of this Site's parent Company. If blank, this record is a Head Office rather than a Site. This field is only present on ServiceM8 Accounts with the Company Sites addon activated.

uuid

Unique identifier for this record

website

string

address_street

string

length ≤ 500

address_city

string

address_state

string

address_postcode

string

address_country

string

fax_number

string

badges

string

JSON Array of Badge UUIDs

tax_rate_uuid

uuid

billing_attention

string

payment_terms

string

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request - The request is malformed or contains invalid parameters

401Unauthorized - Authentication credentials are missing or invalid

403Forbidden - You don't have permission to create this resource

429Too Many Requests - You have exceeded the rate limit

500Internal Server Error - An unexpected error occurred on the server