探马OpenAPI

映射外部CRM客户数据字段

POST

/api/v2/customer/field-mapping

每次调用后会导致之前的映射方案完全被当前映射方案替换。
可用服务版本
营销版、企微基础版、企微高级版

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

mappings

array [object {2}]

映射列表

必需

此列表为期望完成映射的所有字段，所有不在此列表中的历史映射字段会被清除映射。

integer

映射字段id

必需

id为负数的字段不支持字段映射。调用字段映射操作不会生效

outerField

string

映射外部字段

必需

示例

{
  "mappings": [
    {
      "id": 4010,
      "outerField": "remaining_asset_beauty"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v2/customer/field-mapping' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mappings": [
        {
            "id": 4010,
            "outerField": "remaining_asset_beauty"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

业务状态码

必需

成功状态为0。参见响应业务状态码表

message

string

业务状态说明。

必需

示例

{
  "code": 0,
  "message": "已更新映射"
}

🟢200异常

修改于 2022-02-23 02:27:45

列出客户数据字段列表

按企微客户id获取详情