修改客户 - 探马OpenAPI

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

customerId

number

客户id

必需

通过获取客户id 获取。

salesId

number

销售id

可选

通过获取员工id 获取；指定销售id，只会更新该销售跟进的客户信息，不指定销售id，默认更新客户库所有该客户的信息（如：一个客户，多个销售跟进，客户信息都更新）。

stageFlowId

number

旅程id

可选

stageId

number

阶段id

可选

如果有旅程id则阶段id必传

fields

array [object {2}]

字段列表

必需

通过查询客户字段列表获取探马系统所有客户字段。

alias

string

映射字段别名

必需

通过客户字段映射配置外部CRM字段映射，已映射的客户字段才会被修改，未配置映射关系的字段不会被修改。

values

array[string]

映射字段的value

必需

只有多选字段可以提供多于一个值，其他类型字段只应传一个值；不论是否单、多选字段，需要传值，而不是传值id，平台内部进行转换，如果传入的值不是可选项中的值，非法。
如果是级联字段按层级传入字段选项id值（查询客户字段），如["一级id","二级id","三级id"]

注：手机号的修改会在原值追加，不会覆盖，最多支持5个

示例

{
    "customerId":469374418802752,
    "fields":[
        {
            "alias":"lv-id",
            "values":[
                "9527"
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v3/customer/update-by-id' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId":469374418802752,
    "fields":[
        {
            "alias":"lv-id",
            "values":[
                "9527"
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

message

string

状态描述

必需

data

array [object {6}]

响应数据

必需

code

integer

状态码

可选

message

string

描述

可选

salesId

integer

销售id

可选

customerId

integer

客户id

可选

qwUserId

string

销售人员企微id

可选

externalUserId

string

企微客户唯一标识

可选

示例

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "code": 0,
            "message": "success",
            "salesId": 463370430165056,
            "customerId": 456281803624448,
            "qwUserId": "v_1",
            "externalUserId": "wmvRo3DwAAqqJU-6ODQd-MBzC9ID-AiA"
        }
    ]
}