Sign in
Clients

Update a Client

OAuth Scope

This endpoint requires the following OAuth scope manage_customers.

post/company/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Client

Request body

namestring required

Company Name

abn_numberstring

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.

addressstring

Password

billing_addressstring

Confirm Password

is_individual0 | 1

Derived flag indicating whether the client is an individual. This value is set automatically based on the company name and contact first/last name, and cannot be set via the API.. Valid values are [0,1]

{"stackTrail":"components:schemas:CompanyCreate:properties:parent_company_uuid","oasType":"schema","type":"unknown","description":"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."}
uuidstring uuid

Unique identifier for this record

websitestring
address_streetstring
address_citystring
address_statestring
address_postcodestring
address_countrystring
fax_numberstring
badgesstring

JSON Array of Badge UUIDs

tax_rate_uuidstring uuid
billing_attentionstring
payment_termsstring

Example request

{
  "uuid": "123e4567-a3d7-481d-9fd7-23f949ae197b",
  "tax_rate_uuid": "123e4567-4eba-4df4-ab52-23f94ef1ad9b"
}

Response

Success - The record was updated successfully

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 3 of the 50 revisions of this API.118

  • 509ed0fe995813See the full diff
    • ▲

      request property is_individual was restricted to a list of enum values

      request-property-became-enum

    • ○

      the request optional property is_individual became read-only

      request-optional-property-became-read-only

    • ○

      added the new 0.00 enum value to the request property is_individual

      request-property-enum-value-added

    • ○

      added the new 1.00 enum value to the request property is_individual

      request-property-enum-value-added

  • 638a8df09bf41See the full diff
    • ●

      removed the request property active

      request-property-removed

  • ca9b053c43735See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added