删除客户接口

POST

/api/v1/customer/delete

功能说明：

本接口可以实现删除客户的功能

通过客户sysytemData（系统数据）或wecomData（企业微信数据）主动删除客户

接口请求时“sysytemData”和“wecomData”字段任选其一上传；同时传值时，以sysytemData为准执行

💡

此接口不会进行客户流失状态的校验，接口上传的客户会直接执行主动删除操作，请谨慎操作

请求参数

Query 参数

token

string

企业级接口调用凭证

必需

Body 参数application/json

systemData

object

可选

imBotId

string

托管账号的系统联系人id

必需

imContactId

string

客户的系统联系人id

必需

wecomData

object

可选

wecomUserId

string

托管账号的企业微信员工id

必需

externalUserId

string

客户的企业微信联系人id

必需

示例

{
    "systemData": {
        "imBotId": "string",
        "imContactId": "string"
    },
    "wecomData": {
        "wecomUserId": "string",
        "externalUserId": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/customer/delete?token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "systemData": {
        "imBotId": "string",
        "imContactId": "string"
    },
    "wecomData": {
        "wecomUserId": "string",
        "externalUserId": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

1 无效token 2 无效参数

示例

{
    "errcode": 0
}

修改于 2024-09-06 09:37:58

系统wxid转换企业微信外部联系人externalUserId

添加客户接口