Clients

Delete a Client

Changed on

In ServiceM8, deleting a record sets its active field to 0. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their active field to 1.

OAuth Scope

This endpoint requires the following OAuth scope manage_customers.

delete/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

Response

Client successfully archived (soft deleted)

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status