SubClient

Deletes a SubClient (to be with enabled sub-clients module)

This API can be used on instances with enabled sub-clients module only. API deletes a SubClient. Its own template- and integration configurations, settings, API tokens and users are deleted too. A SubClient with processing history (rendering requests, reports, imports and the like) can not be deleted; the API answers 400 with the reason.

DELETE/api/sub-clients/{id}

Deletes a SubClient (to be with enabled sub-clients module)

curl --request DELETE \
  --url 'https://app.output.rocks/api/sub-clients/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

401

application/json

{
  "status": 1,
  "message": "string",
  "errorCode": "auth.unauthenticated",
  "violations": [
    {
      "errorCode": "validation.not_unique"
    }
  ]
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

SubClient identifier

Response

401application/json

Authentication is required.

status

integer

HTTP status code.

message

string

Human-readable message; do not use for programmatic decisions.

errorCode

string

Stable, readable error code. Unknown codes must be handled generically.

violations

object[]

errorCode

value

Example: "auth.unauthenticated"