- hokan API v2
- v1からの移行について
- 顧客
- メモ
- 予定
- ToDo
- プロジェクト
- 世帯
- ユーザー
- グループ
- 活動項目
- フォーマット
- 流入経路
- ファイル
Update customer
PATCH
/api/ext/v2/customers/{pk}
customer
data に extra_values が含まれる場合、送信されていない追加項目は削除されます。
既存の値を更新する場合、残したい追加項目の値を含んだ形で送信してください。
data に extra_values が含まれない場合、追加項目は更新されません。
Request
Path Params
pk
integer
Pk
Body Params application/json
data
Data
Any of
customer_type
enum<string>
顧客タイプ
Allowed value:
individual
person_in_charge_id
integer
担当者ID
vice_person_in_charge_id
integer
副担当者ID
zip
string
郵便番号
address
string
住所
address_kana
string
住所カナ
tel
string
電話番号
fax
string
電話番号
email
string
メールアドレス
mobile
string
携帯電話
mobile_email
string
携帯メールアドレス
note
string
備考
outer_system_id
string
外部システムID
lead_id
integer
流入経路ID
extra_values
array[object (ExtExtraValueInSchema) {2}]
追加項目
last_name
string
姓
first_name
string
名
last_name_kana
string
姓カナ
first_name_kana
string
名カナ
gender
enum<integer>
性別(男性:1, 女性:2, その他:3)
Allowed values:
123
birthday
string <date>
生年月日
annual_income
integer
年収
savings
integer
貯蓄
living_expenses
integer
生活費
industry
string
業種
job
string
職業
workplace
string
所属会社
position
string
役職
corporate_tel
string
会社電話番号
corporate_email
string
会社Eメール
corporate_mobile
string
会社電話番号
affiliation_code
string
所属コード
<= 10 characters
employee_code
string
社員コード
<= 15 characters
Example
{
"data": {
"customer_type": "individual",
"person_in_charge_id": 0,
"vice_person_in_charge_id": 0,
"zip": "string",
"address": "string",
"address_kana": "string",
"tel": "string",
"fax": "string",
"email": "string",
"mobile": "string",
"mobile_email": "string",
"note": "string",
"outer_system_id": "string",
"lead_id": 0,
"extra_values": [
{
"internal_key": "string",
"value": 0
}
],
"last_name": "string",
"first_name": "string",
"last_name_kana": "string",
"first_name_kana": "string",
"gender": 1,
"birthday": "2019-08-24",
"annual_income": 0,
"savings": 0,
"living_expenses": 0,
"industry": "string",
"job": "string",
"workplace": "string",
"position": "string",
"corporate_tel": "string",
"corporate_email": "string",
"corporate_mobile": "string",
"affiliation_code": "string",
"employee_code": "string"
}
}Responses
🟢200OK
application/json
Body
data
Data
Any of
id
integer
Id
zip
string
郵便番号
<= 255 characters
Default:
address
string
住所
<= 255 characters
Default:
address_kana
string
住所(かな)
<= 255 characters
Default:
tel
string
電話番号
<= 255 characters
Default:
fax
string
FAX番号
<= 255 characters
Default:
email
string
メールアドレス
<= 254 characters
Default:
mobile
string
携帯電話
<= 255 characters
Default:
mobile_email
string
携帯メールアドレス
<= 254 characters
Default:
note
string
備考
Default:
outer_system_id
string
外部システムID
<= 255 characters
Default:
created_at
string <date-time>
作成日時
updated_at
string <date-time>
更新日時
name
string
Name
name_kana
string
Name Kana
customer_type
enum<string>
Customer Type
Allowed value:
individual
sales_status
enum<string>
Sales Status
Allowed values:
未設定見込契約手続き中成立待ち契約成立契約済み失注不明
person_in_charge_id
integer
Person In Charge Id
vice_person_in_charge_id
integer
Vice Person In Charge Id
introducer_id
integer
Introducer Id
lead
object
Lead
extra_values
array[object (ExtExtraValueOutSchema) {3}]
Extra Values
last_name
string
Last Name
last_name_kana
string
Last Name Kana
first_name
string
First Name
first_name_kana
string
First Name Kana
gender
enum<string>
Gender
Allowed values:
男性女性その他未使用
birthday
string <date>
Birthday
annual_income
integer
Annual Income
savings
integer
Savings
living_expenses
integer
Living Expenses
industry
string
Industry
job
string
Job
workplace
string
Workplace
position
string
Position
corporate_tel
string
Corporate Tel
corporate_email
string
Corporate Email
corporate_mobile
string
Corporate Mobile
card_exchanged_at
string <date>
Card Exchanged At
death_date
string <date>
Death Date
affiliation_name
string
Affiliation Name
affiliation_code
string
Affiliation Code
employee_code
string
Employee Code
Example
{
"data": {
"id": 0,
"zip": "",
"address": "",
"address_kana": "",
"tel": "",
"fax": "",
"email": "",
"mobile": "",
"mobile_email": "",
"note": "",
"outer_system_id": "",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "string",
"name_kana": "string",
"customer_type": "individual",
"sales_status": "未設定",
"person_in_charge_id": 0,
"vice_person_in_charge_id": 0,
"introducer_id": 0,
"lead": {
"id": 0,
"name": "string",
"disabled": false,
"color_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"category": "リーズ"
},
"extra_values": [
{
"internal_key": "string",
"value": 0,
"extra_item": {
"id": 0,
"name": "string",
"internal_key": "string",
"group_id": 0,
"data_type": "Integer",
"unit": "Age"
}
}
],
"last_name": "string",
"last_name_kana": "string",
"first_name": "string",
"first_name_kana": "string",
"gender": "",
"birthday": "2019-08-24",
"annual_income": 0,
"savings": 0,
"living_expenses": 0,
"industry": "string",
"job": "string",
"workplace": "string",
"position": "string",
"corporate_tel": "string",
"corporate_email": "string",
"corporate_mobile": "string",
"card_exchanged_at": "2019-08-24",
"death_date": "2019-08-24",
"affiliation_name": "string",
"affiliation_code": "string",
"employee_code": "string"
}
}Modified at 2024-07-05 02:16:09