Create account limit code

Use case

In this example, we will review how to set up an account limit code. This parameter gives a name and description of the account limit that will be configured in the further articles.

Sample API call

To create a new account limit code, make the following call.

Create account limit code

https://account-api.sandbox.tuumplatform.com/api/v1/limits/codes

See more information about this endpoint in the Tuum developer portal.

Sample request

Below is an example body request of the API call for creating an account limit code.

{
  "code": "NEW_ACCOUNT_LIMIT",
  "name": "New account limit",
  "enabled": true
}

curl -L 'https://account-api.sandbox.tuumplatform.com/api/v1/limits/codes' \
-H 'x-channel-code: SYSTEM' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTFUMTM6NDg6MDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODkwODMyODB9.w8DHO1S6HtsPCmAc98IG3F3b7bN2f2m7mlHoXf2gR4U' \
-H 'Content-Type: application/json' \
-d '{
  "code": "NEW_ACCOUNT_LIMIT",
  "name": "New account limit"
}'

Sample response

Below you find an example response body to the API call above.

 {
    "errors": null,
    "validationErrors": null,
    "data": {
        "code": "NEW_ACCOUNT_LIMIT",
        "name": "New account limit",
        "description": null,
        "enabled": true
    }
}

Result

A new limit code NEW_ACCOUNT_LIMIT is created and enabled. This parameter will be used for setting up an account limit type.