更新客户信息

更新指定客户的信息。

请求 URL

PUT {base_url}/dm/open_api/v1/customers/{customerId}

请求参数

路径参数

参数 是否必填 类型 说明
customerId 是 Long 客户 ID。
注： 可使用 查询所有客户 或 查询云 PBX 的客户 接口查询客户 ID。
请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
重要： 请求中未带的参数将被设置为空值。
参数 是否必填 类型 说明
firstName 是 String 名称。
lastName 否 String 姓氏。
company 是 String 公司名称。
email 是 String 邮箱。
businessNumber 否 String 公司电话号码。
mobileNumber 否 String 手机号码。
homeNumber 否 String 家庭电话号码。
faxNumber 否 String 传真号码。
zipCode 否 String 邮政编码。
street 否 String 街道。
city 否 String 城市。
state 否 String 省份。
country 否 String 国家。
remark 否 String 备注。

响应参数

参数 类型 说明
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。

示例

请求示例

更新客户 (ID: 50329401) 的邮箱。

PUT /dm/open_api/v1/customers/50329401 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNzA1MzB9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0MjcyMzMwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiNzY2NzYzMi1jZmZjLTQ4ZDQtYTY1YS01MzYzYmUwODhjMmEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.rtpTweQ6DPwwCEgQcrvdmjIvSOSzeKI4ZZjCgepkE0E
Content-Type: application/json
{
  "firstName": "Leo",
  "lastName": "Ball",
  "company": "Example Company",
  "email": "newemailaddress@example.com",
  "businessNumber": "123456789",
  "mobileNumber": "123456789",
  "faxNumber": "347-111-1111",
  "street": "Metrotech Center",
  "country": "USA",
  "state": "New York",
  "remark": "example"
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "15eba94d-c5b2-47c4-bdcc-109322195bea",
  "status": "Success",
  "time": 1664270677
}