# Update settings (deprecated) (deprecated)

 Update client level settings.

Endpoint: PATCH /api/v1/client
Version: v1.0.3
Security: HMAC

## Header parameters:

  - `x-truex-auth-userid` (string, required)
    Client identifier.

  - `x-truex-auth-timestamp` (string, required)
    Timestamp when request was made in seconds since epoch.

  - `x-truex-auth-token` (string, required)
    The UUID affiliated with the HMAC key.

  - `x-truex-auth-signature` (string, required)
    The computed HMAC signature.

## Request fields (application/json):

  - `id` (string)
    Example: "78901949710270469"

  - `info` (object)

  - `info.self_trade_prevention` (string)
    Set the client level self trade protection instruction.
*  No self trade protections are enabled for this client.
*  All orders entered with this client ID will have cancel aggressive self trade protections enabled.
*  All order entered with this client ID will have cancel both self trade protections enabled.
    Enum: "NONE", "CANCEL_AGGRESSIVE", "CANCEL_BOTH"

## Response 200 fields (application/json):

  - `id` (string)
    Example: "78901949710204932"

  - `status` (string)
    Current client state.
    Enum: "INITIIALIZED", "ACTIVE", "DISABLED"

  - `info` (object)

  - `info.organization_id` (string)
    Must be UUIDv4. [RFC 9562](https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4).
    Example: "ed671d2b-bb9e-4cf5-9eb4-71b6db672207"

  - `info.mnemonic` (string)
    Client supplied human readable name of the client entity.
    Example: "CLIENT1"

  - `info.type` (string)
    Client designation.
    Enum: "INSTITUTION", "INDIVIDUAL", "APPLICATION"

  - `info.maker_fee_tier` (integer)
    Client's current maker fee tier.
    Example: 1

  - `info.taker_fee_tier` (integer)
    Client's current taker fee tier.
    Example: 2

  - `info.self_trade_prevention` (string)
    Client level self trade protection instruction.
*  Client level self trade protections are in an invalid state and may result in order rejection.
*  No self trade protections are enabled for this client.  Can be overridden at the order level.
*  All orders entered with this client ID will have cancel aggressive self trade protections enabled.
*  All order entered with this client ID will have cancel both self trade protections enabled.
    Enum: "INVALID", "NONE", "CANCEL_AGGRESSIVE", "CANCEL_BOTH"

## Response 400 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 401 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 403 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 404 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 408 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 415 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 500 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 503 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).