SubClient

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

This API can be used on instances with enabled sub-clients module only. API updates a SubClient.

PATCH/api/sub-clients/{id}

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

curl --request PATCH \
  --url 'https://app.output.rocks/api/sub-clients/string' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "id123",
  "description": "Any description"
}'

200

application/json

{
  "id": 12345,
  "externalId": "id123",
  "description": "Any description",
  "tokens": [
    {
      "id": 12345,
      "identifier": "default",
      "description": "Any description",
      "token": "Any description"
    }
  ],
  "standardValues": [
    {
      "id": 12345,
      "identifier": "key1",
      "value": "line1\nline2",
      "active": true,
      "activeFrom": "2024-01-01"
    }
  ]
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

SubClient identifier

Request Body

application/json

required

The updated SubClient resource

{
  "externalId": "id123",
  "description": "Any description"
}

Response

200application/json

SubClient resource updated

integer

Identifier generated by Output.Rocks.

Example: 12345

externalId

string

Optional identifier, used in connected system. External ID has to be unique.

Example: "id123"

description

string

SubClient description

Example: "Any description"

tokens

object[]

standardValues

object[]