Clients

Update a Client

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_customers.

post/company/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/company/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_customers

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]

parent_company_uuidunknown
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

  • 509ed0fe9958Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      the request optional property became read-only

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

  • 638a8df09bf4Revision changes
    • warning

      removed the request property