> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/platform-service/zbc/account/modifybalancealert.md).

# ModifyBalanceAlert

## 1. 接口描述

本接口(ModifyBalanceAlert)用于打开或关闭当前账户的余额提醒，并可同时设置提醒阈值。开启后，可用金（账户余额 + 信用值）低于阈值时系统发送提醒邮件。

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称           | 必选 | 类型      | 描述                                                                                                                         |
| -------------- | -- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| enabled        | 是  | Boolean | <p>是否开启余额提醒。</p><p>true 表示开启，false 表示关闭。</p><p>关闭仅停止发送提醒邮件，已设置的阈值仍然保留，再次开启时可直接复用。</p>                                      |
| alertThreshold | 否  | Float   | <p>余额提醒阈值。</p><p>可用金（账户余额 + 信用值）低于该值时按天发送提醒邮件，直至可用金回升到阈值以上。</p><p>首次开启提醒时必填；不传时保留账户原有阈值。</p><p>可选值范围：\[0.0, 999999.99]</p> |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 开启余额提醒并设置提醒阈值。**

```json
POST /api/v2/zbc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyBalanceAlert
<Common Request Params>

Request:
  {
    "enabled": true,
    "alertThreshold": 100.00
  }

Response:
  {
    "requestId": "T7B4E9C21-5A38-4D6F-B012-8E3C7A5D91B4",
    "response": {
      "requestId": "T7B4E9C21-5A38-4D6F-B012-8E3C7A5D91B4"
    }
  }
```

**2. 关闭余额提醒，保留已设置的阈值。**

```json
POST /api/v2/zbc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyBalanceAlert
<Common Request Params>

Request:
  {
    "enabled": false
  }

Response:
  {
    "requestId": "TA2F6D08C-91B3-4E75-8C24-5D7F0A6B3E19",
    "response": {
      "requestId": "TA2F6D08C-91B3-4E75-8C24-5D7F0A6B3E19"
    }
  }
```

**3. 仅调整提醒阈值，保持提醒开启。**

```json
POST /api/v2/zbc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyBalanceAlert
<Common Request Params>

Request:
  {
    "enabled": true,
    "alertThreshold": 500.00
  }

Response:
  {
    "requestId": "TC8039E1B-4A72-4F63-9D85-2B6E1C4A87D0",
    "response": {
      "requestId": "TC8039E1B-4A72-4F63-9D85-2B6E1C4A87D0"
    }
  }
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码                                          | 说明                |
| ------- | -------------------------------------------- | ----------------- |
| 404     | INVALID\_ACCOUNT\_NOT\_FOUND                 | 账户不存在。            |
| 400     | INVALID\_BALANCE\_ALERT\_THRESHOLD\_REQUIRED | 首次开启余额提醒时未指定提醒阈值。 |
