You need to enable JavaScript to run this app.
导航
客户数据平台（私有化）
  • 文档首页
    • /客户数据平台（私有化）/开放能力/OpenAPI/用户分群/legacyModifyManualSegment - 修改人工分群
legacyModifyManualSegment - 修改人工分群
最近更新时间：2024.07.25 14:46:09首次发布时间：2024.07.10 15:50:08
我的收藏

请求说明

  • 请求方式：PATCH
  • 接口名称：legacyModifyManualSegment
  • 请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

legacyModifyManualSegment

对应“请求说明”中的“接口名称”

ApiVersion

String

是

2023-08-08

版本号：2023-08-08

tenantId

Int

是

1

租户Code (请不要填写租户ID，获取方式详见附录)

segId

Int

是

1

分群ID

Body

参数

类型

是否必选

示例值

描述

name

String

是

分群名称

分群名称，长度128

description

String

否

描述

分群描述，长度255

sourceIdType

String

是

web_id

源实体code

targetIdType

String

是

baseid

目标实体code

abaseEnabled

Boolean

否

true

是否开启分群在线服务

sourcePlatform

String

否

null

来源平台

detail

Object

是

{
    "uploadTaskId": 1,//文件上传id，由上传分群文件接口获取
    "updateMode": "ADD"//更新模式：ADD-追加
}

上传分群规则

{
    "uploadTaskId": 1,//文件上传id，由上传分群文件接口获取
    "updateMode": "ADD"//更新模式：ADD-追加
}
  • detail字段内容

参数

类型

是否必选

示例值

描述

uploadTaskId

Int

是

1

上传任务id

segmentId

Int

是

导入分群id

updateMode

String

是

ADD

更新模式

返回参数

参数

类型

示例值

描述

code

Int

0

状态码：0 为成功。错误码见附录7.3

msg

String

SUCCESS

状态信息

data

String

success

成功或失败信息

请求示例

{
    "name": "分群名称",
    "desc": "描述",
    "sourceIdType": "web_id",
    "targetIdType": "baseid",
    "detail": {
        "uploadTaskId": 1,
        "updateMode": "ADD"
    },
    "sourcePlatform": null
}

返回示例

{
    "code": 0,
    "msg": "SUCCESS",
    "data": "success"
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。