---
agentTools:
  projectIndex: https://sendinblue.readme.io/llms.txt
---

# Create balance limits

Creates balance limit and sends the created UUID along with the data

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "contact@brevo.com",
      "name": "Brevo Support",
      "url": "https://account.brevo.com/support"
    },
    "description": "Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :\n  - Manage your campaigns and get the statistics\n  - Manage your contacts\n  - Send transactional Emails and SMS\n  - and much more...\n\nYou can download our wrappers at https://github.com/orgs/brevo\n**Possible responses**\n  | Code | Message |\n  | :-------------: | ------------- |\n  | 200  | OK. Successful Request  |\n  | 201  | OK. Successful Creation |\n  | 202  | OK. Request accepted |\n  | 204  | OK. Successful Update/Deletion  |\n  | 400  | Error. Bad Request  |\n  | 401  | Error. Authentication Needed  |\n  | 402  | Error. Not enough credit, plan upgrade needed  |\n  | 403  | Error. Permission denied  |\n  | 404  | Error. Object does not exist |\n  | 405  | Error. Method not allowed  |\n  | 406  | Error. Not Acceptable  |\n  | 422  | Error. Unprocessable Entity |\n",
    "license": {
      "name": "MIT",
      "url": "http://opensource.org/licenses/MIT"
    },
    "title": "Brevo API",
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://api.brevo.com/v3"
    }
  ],
  "security": [
    {
      "api-key": []
    },
    {
      "partner-key": []
    }
  ],
  "paths": {
    "/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits": {
      "post": {
        "description": "Creates balance limit and sends the created UUID along with the data",
        "operationId": "createBalanceLimit",
        "parameters": [
          {
            "description": "Loyalty Program Id",
            "in": "path",
            "name": "pid",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "Balance Definition Id",
            "in": "path",
            "name": "bdid",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "Payload for setting transaction or amount-based limits on a balance.",
                "properties": {
                  "constraintType": {
                    "description": "Defines whether the limit applies to transaction count or amount.",
                    "enum": [
                      "transaction",
                      "amount"
                    ],
                    "type": "string"
                  },
                  "durationUnit": {
                    "description": "Unit of time for which the limit is applicable.",
                    "enum": [
                      "day",
                      "week",
                      "month",
                      "year"
                    ],
                    "type": "string"
                  },
                  "durationValue": {
                    "description": "Number of time units for the balance limit.",
                    "type": "integer"
                  },
                  "slidingSchedule": {
                    "description": "Determines if the limit resets on a rolling schedule.",
                    "type": "boolean"
                  },
                  "transactionType": {
                    "description": "Specifies whether the limit applies to credit or debit transactions.",
                    "enum": [
                      "credit",
                      "debit"
                    ],
                    "type": "string"
                  },
                  "value": {
                    "description": "Maximum allowed value for the specified constraint type.",
                    "type": "integer"
                  }
                },
                "required": [
                  "constraintType",
                  "durationUnit",
                  "durationValue",
                  "transactionType",
                  "value"
                ],
                "type": "object"
              }
            }
          },
          "description": "Balance Definition Payload",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/balanceLimit"
                }
              }
            },
            "description": "Successful creation of balance limit"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Request Authentication Failed"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Cannot Authenticate Request"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Validation errors"
          },
          "424": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Failed Dependency Error"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Internal error occurred"
          }
        },
        "summary": "Create balance limits",
        "tags": [
          "Balance"
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api-key": {
        "description": "The API key should be passed in the request headers as `api-key` for authentication.",
        "in": "header",
        "name": "api-key",
        "type": "apiKey"
      },
      "partner-key": {
        "description": "The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).",
        "in": "header",
        "name": "partner-key",
        "type": "apiKey"
      }
    },
    "schemas": {
      "errorModel": {
        "properties": {
          "code": {
            "description": "Error code displayed in case of a failure",
            "example": "method_not_allowed",
            "type": "string"
          },
          "message": {
            "description": "Readable message associated to the failure",
            "example": "POST Method is not allowed on this path",
            "type": "string"
          }
        },
        "required": [
          "message"
        ],
        "type": "object"
      },
      "balanceLimit": {
        "properties": {
          "balanceDefinitionId": {
            "description": "balance definition ID",
            "type": "string"
          },
          "constraintType": {
            "description": "Defines the type of constraint (e.g., transaction-based or amount-based).",
            "type": "string"
          },
          "createdAt": {
            "description": "Timestamp of when the balance limit was created.",
            "type": "string"
          },
          "durationUnit": {
            "description": "Time unit for the balance limit (day, week, month, year).",
            "type": "string"
          },
          "durationValue": {
            "description": "Number of time units the balance limit applies to.",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the balance limit.",
            "type": "string"
          },
          "slidingSchedule": {
            "description": "Indicates if the limit resets periodically based on a sliding schedule.",
            "type": "boolean"
          },
          "transactionType": {
            "description": "Specifies whether the limit applies to credit or debit transactions.",
            "type": "string"
          },
          "updatedAt": {
            "description": "Timestamp of the last update to the balance limit.",
            "type": "string"
          },
          "value": {
            "description": "The maximum allowed value for the defined constraint.",
            "type": "integer"
          }
        },
        "required": [
          "createdAt",
          "updatedAt"
        ],
        "type": "object"
      }
    }
  },
  "x-samples-languages": [
    "curl"
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 91,
      "1": 104,
      "2": 180,
      "3": 205,
      "4": 240,
      "5": 82,
      "6": 207,
      "7": 0,
      "8": 3,
      "9": 36,
      "10": 63,
      "11": 142
    }
  }
}
```