批量预设客户属性

POST

/open-api/pre_write_properties/batch_add

openapi

根据多个手机号或多个union_id匹配多名外部用户,匹配成功后批量设置对应的属性。如果一次请求中，对应的phone_number或union_id有重复，只取首次出现的字段。调用此接口需购买营销席位。

错误码	说明
21820	员工id错误
21821	手机号格式不正确
21822	union_id格式不正确
21823	生日格式不正确
21824	时间格式不正确
21825	预设属性最少录入两列
21826	无效的field_id
21827	自定义字段缺少对应的类型参数
21828	field_id和field_name不匹配
21829	field_id和option_id不匹配
21830	创建预设属性失败
21831	缺少必传参数union_id或phone_number
21832	value_list长度限制最多50个
21833	openid格式不正确

请求参数

Query 参数

access_token

string

调用接口凭证

必需

默认值:

Body 参数application/json

coverage_information_is_enable

boolean

是否覆盖已有信息

必需

target_type

string

必需

预填属性类型,union_id或mobile

staff_id

string

操作员工id

必需

value_list

array [object {13}]

可选

union_id

string

可选

微信客户的union_id

openid

string

可选

微信客户的openid（密文企业，且用union_id匹配时必传）

phone_number

string

可选

手机号，当target_type类型为mobile时必填

state

string

基本信息，来源

可选

age

string

基本信息，年龄

可选

description

string

基本信息，描述

可选

string

基本信息，邮箱

可选

birthday

string

基本信息，生日

可选

weibo

string

基本信息，微博

可选

string

基本信息，qq

可选

address

string

基本信息，地址

可选

remark

string

基本信息，备注名

可选

cf_fields

array [object {6}]

可选

示例

{
    "coverage_information_is_enable": true,
    "target_type": "string",
    "staff_id": "string",
    "value_list": [
        {
            "union_id": "string",
            "openid": "string",
            "phone_number": "string",
            "state": "string",
            "age": "string",
            "description": "string",
            "email": "string",
            "birthday": "string",
            "weibo": "string",
            "qq": "string",
            "address": "string",
            "remark": "string",
            "cf_fields": [
                {
                    "field_id": 0,
                    "field_name": "string",
                    "field_datetime": "string",
                    "option_id": 0,
                    "field_value": "string",
                    "number_value": 0
                }
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.weibanzhushou.com/open-api/pre_write_properties/batch_add?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "coverage_information_is_enable": true,
    "target_type": "string",
    "staff_id": "string",
    "value_list": [
        {
            "union_id": "string",
            "openid": "string",
            "phone_number": "string",
            "state": "string",
            "age": "string",
            "description": "string",
            "email": "string",
            "birthday": "string",
            "weibo": "string",
            "qq": "string",
            "address": "string",
            "remark": "string",
            "cf_fields": [
                {
                    "field_id": 0,
                    "field_name": "string",
                    "field_datetime": "string",
                    "option_id": 0,
                    "field_value": "string",
                    "number_value": 0
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{
    "errcode": 0,
    "errmsg": "ok"
}

🟢200正常返回

修改于 2025-01-10 03:15:03

添加自定义字段

批量修改自定义字段的值