探马OpenAPI

企业客户导入

POST

/api/v3/import-corpCustomer

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

companyId

number

企业id

必需

salesId

number

负责人id

必需

customerFieldAlias

array [object {2}]

客户字段

必需

alias

string

字段别名

必需

values

array[string]

字段值

必需

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

contacts

array [object {1}]

联系人列表

必需

contactFieldAlias

array [object {2}]

必需

示例

{
  "salesStage": 450092363612224,
  "stageFlowId": 506686982789184,
  "companyId": 570781629626304,
  "salesId": 489761575145536,
  "customerFieldAlias": [
    {
      "alias": "age",
      "values": [
        "55"
      ]
    },
    {
      "alias": "jilian",
      "values": [
        "1",
        "0"
      ]
    }
  ],
  "contacts": [
    {
      "contactFieldAlias": [
        {
          "alias": "customerName",
          "values": [
            "111"
          ]
        },
        {
          "alias": "area",
          "values": [
            "北京市/北京市/西城区"
          ]
        },
        {
          "alias": "phoneNumber",
          "values": [
            "19105263998"
          ]
        }
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/import-corpCustomer' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "salesStage": 450092363612224,
  "stageFlowId":506686982789184,
  "companyId": 570781629626304,
  "salesId": 489761575145536,
  "customerFieldAlias": [
    {
      "alias":"age",
      "values":["55"]
    },
    {
      "alias":"jilian",
      "values":["1","0"]
    }
  ],
  "contacts": [
    {
      "contactFieldAlias":[
        {
          "alias":"customerName",
          "values":["111"]
        },{
          "alias":"area",
          "values":["北京市/北京市/西城区"]
        },
        {
          "alias":"phoneNumber",
          "values":["19105263998"]
        }
      ]
    }
  ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

number

客户id

必需

示例

{
  "code": 0,
  "message": "success",
  "data": 570784914833472
}

修改于 2023-11-01 08:20:18

企业待分配客户导入

必读说明