HotProfile (プレビュー)
HotProfile は、名刺データ変換データの管理を自動化します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Hotprofile suport |
| URL | https://www.hammock.jp/hpr/support/ |
| hpf_support@hammock.co.jp |
| コネクタ メタデータ | |
|---|---|
| Publisher | 株式会社オーシャンズ |
| Website | https://hammock.hotprofile.biz/ |
| プライバシー ポリシー | https://www.hammock.jp/securitypolicy/privacypolicy.html |
| カテゴリ | 売上と CRM |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| HotProfile API キー | securestring | HotProfile API キー | 正しい |
| HotProfile URL インスタンス | 文字列 | HotProfile インスタンスの URL (例: https://example.hot-profile.com/ -><example.hot-profile.com> | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| クライアントを取得する |
HotProfile に登録されているクライアントを取得する |
| クライアントを更新する |
HotProfile でクライアントを更新する |
| クライアントを登録する |
クライアントを HotProfile に登録する |
| リードを登録する |
リードを HotProfile に登録する |
| 名刺を取得する |
HotProfile に登録されている名刺を取得する |
| 名刺を更新する |
HotProfile で名刺を更新する |
| 名刺を登録する |
HotProfile に名刺を登録する |
| 潜在顧客を得る |
HotProfile に登録された潜在顧客を取得する |
| 潜在顧客を更新する |
HotProfile でリードを更新する |
クライアントを取得する
HotProfile に登録されているクライアントを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page[number] | integer |
1 バイトの数値 (1 ~) |
|
|
1 ページの数を取得する
|
page[display_number] | integer |
1 バイトの数値 (1 ~ 1000) |
|
|
日付項目形式指定オプション
|
page[date_format_option] | integer |
0:off または 1:on |
|
|
並べ替える項目
|
order[key] | string |
オーバー |
|
|
並べ替えの方向
|
order[type] | string |
asc または desc |
|
|
クライアント ID (検索から)
|
search[from_id] | integer |
id> = from_idfromのみ指定できます。 |
|
|
クライアント ID (検索対象)
|
search[to_id] | integer |
id <= to_idtoのみ指定できます。 |
|
|
クライアント名
|
search[name] | string |
部分一致 |
|
|
クライアント名 かな
|
search[name_kana] | string |
部分一致 |
|
|
略称
|
search[name_disp] | string |
部分一致 |
|
|
郵便番号
|
search[zip] | string |
部分一致 |
|
|
番地
|
search[address] | string |
部分一致 |
|
|
緯度
|
search[latitude] | string |
部分一致 |
|
|
経度
|
search[longitude] | string |
部分一致 |
|
|
雇用主識別番号
|
search[corporate_number] | string |
部分一致 |
|
|
代表電話番号
|
search[main_tel] | string |
部分一致 |
|
|
URL
|
search[url] | string |
部分一致 |
|
|
電子メール ドメイン
|
search[mail_domain] | string |
部分一致 |
|
|
メモ
|
search[note] | string |
部分一致 |
|
|
営業担当者
|
search[user_ids] | integer |
登録されているユーザーの ID のみ |
|
|
クライアント名 (第 2 言語)
|
search[name_sub] | string |
第 2 言語機能のみが有効になっている場合 |
|
|
クライアント名かな (第 2 言語)
|
search[name_kana_sub] | string |
第 2 言語機能のみが有効になっている場合 |
|
|
郵便番号 (第 2 言語)
|
search[zip_sub] | string |
第 2 言語機能のみが有効になっている場合 |
|
|
住所 (第 2 言語)
|
search[address_sub] | string |
第 2 言語機能のみが有効になっている場合 |
|
|
状態 (第 2 言語)
|
search[pref_sub] | string |
第 2 言語機能のみが有効になっている場合 |
|
|
入力日 (検索から)
|
search[from_created_on] | string |
yyyy / mm / dd |
|
|
入力日 (検索対象)
|
search[to_created_on] | string |
yyyy / mm / dd |
|
|
日付 (検索から)
|
search[from_updated_on] | string |
yyyy / mm / dd |
|
|
更新日 (検索)
|
search[to_updated_on] | string |
yyyy / mm / dd |
|
|
日付と時刻の更新 (検索から)
|
search[from_datetime_updated_on] | string |
yyyy / mm / dd HH: mm: ss |
|
|
日付と時刻の更新 (検索)
|
search[to_datetime_updated_on] | string |
yyyy / mm / dd HH: mm: ss |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
clients
|
clients | array of object |
clients |
|
会社 ID
|
clients.id | integer |
会社 ID |
|
会社名
|
clients.name | string |
会社名 |
|
会社名 かな
|
clients.name_kana | string |
会社名 かな |
|
会社名の省略形
|
clients.name_disp | string |
会社名の省略形 |
|
郵便番号
|
clients.zip | string |
郵便番号 |
|
県
|
clients.pref | string |
県 |
|
番地
|
clients.address | string |
番地 |
|
番地 1
|
clients.address1 | string |
番地 1 |
|
番地 2
|
clients.address2 | string |
番地 2 |
|
番地 3
|
clients.address3 | string |
番地 3 |
|
緯度
|
clients.latitude | string |
緯度 |
|
経度
|
clients.longitude | string |
経度 |
|
業種
|
clients.business_category_kbn | string |
業種 |
|
従業員数
|
clients.worker_number_kbn | string |
従業員数 |
|
資本ストック
|
clients.capital_kbn | string |
資本ストック |
|
一覧に表示される部門
|
clients.ipo_kbn | string |
一覧に表示される部門 |
|
昨年の売上
|
clients.sales_last_year | string |
昨年の売上 |
|
代表電話番号
|
clients.main_tel | string |
代表電話番号 |
|
URL
|
clients.url | string |
URL |
|
電子メール ドメイン
|
clients.mail_domain | string |
電子メール ドメイン |
|
メモ
|
clients.note | string |
メモ |
|
営業担当者
|
clients.user_name | string |
営業担当者 |
|
販売員 ID
|
clients.user_code | string |
販売員 ID |
|
雇用主識別番号
|
clients.corporate_number | integer |
雇用主識別番号 |
|
入力日
|
clients.created_at | string |
入力日 |
|
改築日
|
clients.updated_at | string |
改築日 |
|
カスタム項目リスト
|
clients.items | array of string |
カスタム項目リスト |
|
カスタム項目ラベル
|
clients.itemslabel | string |
カスタム項目ラベル |
|
カスタム項目の値
|
clients.itemsvalue | string |
カスタム項目の値 |
|
検索結果の数
|
clients.total_count | integer |
検索結果の数 |
|
ページの合計数
|
clients.total_number | integer |
ページの合計数 |
|
現在のページの番号
|
clients.current_number | integer |
現在のページの番号 |
|
1ページの取得数
|
clients.display_number | integer |
1ページの取得数 |
|
現在のページの番号
|
pages.current_number | integer |
現在のページの番号 |
|
1ページの取得数
|
pages.display_number | integer |
1ページの取得数 |
|
検索結果の数
|
pages.total_count | integer |
検索結果の数 |
|
ページの合計数
|
pages.total_number | integer |
ページの合計数 |
クライアントを更新する
HotProfile でクライアントを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアントID
|
id | True | integer |
登録されているクライアントの ID のみ |
|
クライアント名
|
name | string |
255 文字以下 |
|
|
クライアント名 かな
|
name_kana | string |
255 文字以下 |
|
|
クライアント名の省略形
|
name_disp | string |
255 文字以下 |
|
|
郵便番号
|
zip | string |
100 文字以下 |
|
|
県
|
pref_id | integer |
登録されている状態コードのみ |
|
|
番地
|
address | string |
255 文字以下 |
|
|
緯度
|
latitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
経度
|
longitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
業種
|
business_category_kbn | integer |
登録されている業界セグメント ID のみ |
|
|
従業員数
|
worker_number_kbn | integer |
登録されている従業員の分類 ID 番号のみ |
|
|
資本ストック
|
capital_kbn | integer |
登録されている資本分類 ID のみ |
|
|
一覧に表示される部門
|
ipo_kbn | integer |
登録されている分類 ID のみを一覧表示する |
|
|
昨年の売上
|
sales_last_year | string |
255 文字以下 |
|
|
代表電話番号
|
main_tel | string |
255 文字以下 |
|
|
URL
|
url | string |
255 文字以下 |
|
|
電子メール ドメイン
|
mail_domain | string |
255 文字以下 |
|
|
販売員ユーザー ID
|
user_id | integer |
登録されているユーザーの ID のみ |
|
|
メモ
|
note | string |
3000 文字以下 |
|
|
クライアント名 (第 2 言語)
|
name_sub | string |
255 文字以下 |
|
|
クライアント名かな (第 2 言語)
|
name_kana_sub | string |
255 文字以下 |
|
|
郵便番号 (第 2 言語)
|
zip_sub | string |
100 文字以下 |
|
|
住所 (第 2 言語)
|
address_sub | string |
255 文字以下 |
|
|
状態 (第 2 言語)
|
pref_sub | string |
255 文字以下 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
id |
クライアントを登録する
クライアントを HotProfile に登録する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアント名
|
name | True | string |
255 文字以下 |
|
クライアント名 かな
|
name_kana | string |
255 文字以下 |
|
|
クライアント名の省略形
|
name_disp | True | string |
255 文字以下 |
|
郵便番号
|
zip | string |
100 文字以下 |
|
|
県
|
pref_id | integer |
登録されている状態コードのみ |
|
|
番地
|
address | string |
255 文字以下 |
|
|
緯度
|
latitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
経度
|
longitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
業種
|
business_category_kbn | integer |
登録されている業界セグメント ID のみ |
|
|
従業員数
|
worker_number_kbn | integer |
登録されている従業員の分類 ID 番号のみ |
|
|
資本ストック
|
capital_kbn | integer |
登録されている資本分類 ID のみ |
|
|
一覧に表示される部門
|
ipo_kbn | integer |
登録されている分類 ID のみを一覧表示する |
|
|
昨年の売上
|
sales_last_year | string |
255 文字以下 |
|
|
代表電話番号
|
main_tel | string |
255 文字以下 |
|
|
URL
|
url | string |
255 文字以下 |
|
|
電子メール ドメイン
|
mail_domain | string |
255 文字以下 |
|
|
販売員ユーザー ID
|
user_id | integer |
登録されているユーザーの ID のみ |
|
|
メモ
|
note | string |
3000 文字以下 |
|
|
クライアント名 (第 2 言語)
|
name_sub | string |
255 文字以下 |
|
|
クライアント名かな (第 2 言語)
|
name_kana_sub | string |
255 文字以下 |
|
|
郵便番号 (第 2 言語)
|
zip_sub | string |
100 文字以下 |
|
|
住所 (第 2 言語)
|
address_sub | string |
255 文字以下 |
|
|
状態 (第 2 言語)
|
pref_sub | string |
255 文字以下 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
id |
リードを登録する
リードを HotProfile に登録する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアントID
|
client_id | True | integer |
登録されているクライアントの ID のみ |
|
Surname
|
family_name | True | string |
100 文字以下 |
|
名前
|
first_name | string |
100 文字以下 |
|
|
姓 (かな)
|
family_name_kana | string |
100 文字以下 |
|
|
名前 (かな)
|
first_name_kana | string |
100 文字以下 |
|
|
部門 ID
|
organization_id | integer |
登録されているクライアントの ID のみ |
|
|
位置
|
post | string |
255 文字以下 |
|
|
電話番号
|
tel | string |
100 文字以下 |
|
|
内線番号
|
extension | integer |
最大 8 文字の整数 |
|
|
ファクシミリ
|
fax | string |
100 文字以下 |
|
|
メール アドレス
|
string |
200 文字以下 |
||
|
携帯電話番号
|
mobile_tel | string |
100 文字以下 |
|
|
モバイル電子メール アドレス
|
mobile_email | string |
100 文字以下 |
|
|
郵便番号
|
zip | string |
50 文字以下 |
|
|
都道府県コード
|
pref_id | integer |
都道府県の選択に存在する ID のみ |
|
|
番地
|
address | string |
255 文字以下 |
|
|
URL
|
url | string |
255 文字以下 |
|
|
読み取り状態
|
lead_status | integer |
読み取り状態の選択に存在する ID のみ |
|
|
緯度
|
latitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
経度
|
longitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
リード ソース ID
|
lead_source_kbn_id | integer |
潜在顧客管理 - 選択肢管理のリード ソースに登録されている ID のみ |
|
|
リード ソースの詳細
|
lead_source | string |
3000 文字以下 |
|
|
メモ
|
note | string |
3000 文字以下 |
|
|
電子メール エラー
|
error_mail_flg | boolean |
フラグ |
|
|
電話番号エラー
|
error_tel_flg | boolean |
フラグ |
|
|
FAX 番号エラー
|
error_fax_flg | boolean |
フラグ |
|
|
アドレス エラー
|
error_address_flg | boolean |
フラグ |
|
|
電子メールの拒否
|
not_mail_flg | boolean |
フラグ |
|
|
通話拒否
|
not_tel_flg | boolean |
フラグ |
|
|
FAX 配信拒否
|
not_fax_flg | boolean |
フラグ |
|
|
DM配信拒否
|
not_dm_flg | boolean |
フラグ |
|
|
競合 他社
|
competitor_flg | boolean |
フラグ |
|
|
重要なお客様
|
important_customer_flg | boolean |
フラグ |
|
|
エンド ユーザー
|
end_user_flg | boolean |
フラグ |
|
|
販売店舗
|
store_flg | boolean |
フラグ |
|
|
顧客ID
|
customer_id | string |
255 文字以下 |
|
|
販売員ユーザー ID
|
owner_user_id | string |
登録されているユーザーの ID のみ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
ID |
名刺を取得する
HotProfile に登録されている名刺を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page[number] | integer |
1 バイトの数値 (1 ~) |
|
|
1 ページの数を取得する
|
page[display_number] | integer |
1 バイトの数値 (1 ~ 1000) |
|
|
日付項目形式指定オプション
|
page[date_format_option] | boolean |
正 または 誤 |
|
|
並べ替える項目
|
order[key] | string |
id、trade_on、updated_at |
|
|
並べ替えの方向
|
order[type] | string |
asc または desc |
|
|
名前 (姓)
|
search[family_name] | string |
部分一致 |
|
|
フル ネーム (名)
|
search[first_name] | string |
部分一致 |
|
|
姓 (かな)
|
search[family_name_kana] | string |
部分一致 |
|
|
名前 (かな)
|
search[first_name_kana] | string |
部分一致 |
|
|
クライアント名
|
search[client_name] | string |
部分一致 |
|
|
名刺交換日 (検索から)
|
search[from_trade_on] | string |
yyyy / mm / dd |
|
|
名刺交換日 (検索対象)
|
search[to_trade_on] | string |
yyyy / mm / dd |
|
|
日付 (検索から)
|
search[from_updated_on] | string |
yyyy / mm / dd |
|
|
更新日 (検索)
|
search[to_updated_on] | string |
yyyy / mm / dd |
|
|
入力日 (検索から)
|
search[from_created_on] | string |
yyyy / mm / dd |
|
|
入力日 (検索対象)
|
search[to_created_on] | string |
yyyy / mm / dd |
|
|
部署
|
search[organization_ancestry_all_name] | string |
部分一致 |
|
|
位置
|
search[post] | string |
部分一致 |
|
|
電話番号
|
search[tel] | string |
部分一致 |
|
|
ファクシミリ
|
search[fax] | string |
部分一致 |
|
|
携帯電話番号
|
search[mobile_tel] | string |
部分一致 |
|
|
メール アドレス
|
search[email] | string |
部分一致 |
|
|
モバイル電子メール アドレス
|
search[mobile_email] | string |
部分一致 |
|
|
グループ
|
search[role_id] | integer |
機関グループ ID |
|
|
郵便番号
|
search[zip] | string |
部分一致 |
|
|
番地
|
search[address] | string |
部分一致 |
|
|
URL
|
search[url] | string |
部分一致 |
|
|
メモ
|
search[note] | string |
部分一致 |
|
|
手書きのノート
|
search[direct_note] | string |
部分一致 |
|
|
リード ソースの詳細
|
search[lead_source] | string |
部分一致 |
|
|
お問い合わせ番号
|
search[request_key] | string |
部分一致 |
|
|
緯度
|
search[latitude] | integer |
部分一致 |
|
|
経度
|
search[longitude] | integer |
部分一致 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
business_cards
|
business_cards | array of object |
business_cards |
|
番地
|
business_cards.address | string |
番地 |
|
番地 1
|
business_cards.address1 | string |
番地 1 |
|
番地 2
|
business_cards.address2 | string |
番地 2 |
|
番地 3
|
business_cards.address3 | string |
番地 3 |
|
クライアント名
|
business_cards.client_name | string |
クライアント名 |
|
入力日
|
business_cards.created_at | string |
入力日 |
|
手書きのノート
|
business_cards.direct_note | string |
手書きのノート |
|
メール アドレス
|
business_cards.email | string |
メール アドレス |
|
ファクシミリ
|
business_cards.fax | string |
ファクシミリ |
|
名刺 ID
|
business_cards.id | integer |
名刺 ID |
|
緯度
|
business_cards.latitude | string |
緯度 |
|
リード ソースの詳細
|
business_cards.lead_source | string |
リード ソースの詳細 |
|
リード ソース
|
business_cards.lead_source_kbn_id | integer |
リード ソース |
|
経度
|
business_cards.longitude | string |
経度 |
|
モバイル電子メール アドレス
|
business_cards.mobile_email | string |
モバイル電子メール アドレス |
|
携帯電話番号
|
business_cards.mobile_tel | string |
携帯電話番号 |
|
姓名
|
business_cards.name | string |
姓名 |
|
名前 (かな)
|
business_cards.name_kana | string |
名前 (かな) |
|
メモ
|
business_cards.note | string |
メモ |
|
部署
|
business_cards.organization_name | string |
部署 |
|
位置
|
business_cards.post | string |
位置 |
|
県
|
business_cards.pref_id | integer |
県 |
|
お問い合わせ番号
|
business_cards.request_key | string |
お問い合わせ番号 |
|
状態
|
business_cards.status | integer |
状態 |
|
タグ
|
business_cards.tag_ids | array of integer |
タグ |
|
電話番号
|
business_cards.tel | string |
電話番号 |
|
名刺交換日
|
business_cards.trade_on | string |
名刺交換日 |
|
改築日
|
business_cards.updated_at | string |
改築日 |
|
URL
|
business_cards.url | string |
URL |
|
名刺の所有者
|
business_cards.user_name | string |
名刺の所有者 |
|
郵便番号
|
business_cards.zip | string |
郵便番号 |
|
現在のページの番号
|
pages.current_number | integer |
現在のページの番号 |
|
1ページの取得数
|
pages.display_number | integer |
1ページの取得数 |
|
検索結果の数
|
pages.total_count | integer |
検索結果の数 |
|
ページの合計数
|
pages.total_number | integer |
ページの合計数 |
名刺を更新する
HotProfile で名刺を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名刺 ID
|
id | True | integer |
登録されている名刺の ID のみ |
|
クライアントID
|
client_id | True | integer |
登録されているクライアントの ID のみ |
|
部門 ID
|
organization_id | integer |
登録されている部署の ID のみ |
|
|
Surname
|
family_name | string |
100 文字以下 |
|
|
名前
|
first_name | string |
100 文字以下 |
|
|
姓 (かな)
|
family_name_kana | string |
100 文字以下 |
|
|
名前 (かな)
|
first_name_kana | string |
100 文字以下 |
|
|
電話番号
|
tel | string |
100 文字以下 |
|
|
内線番号
|
extension | integer |
最大 8 文字の整数 |
|
|
ファクシミリ
|
fax | string |
100 文字以下 |
|
|
メール アドレス
|
string |
200 文字以下 |
||
|
携帯電話番号
|
mobile_tel | string |
100 文字以下 |
|
|
モバイル電子メール アドレス
|
mobile_email | string |
100 文字以下 |
|
|
郵便番号
|
zip | string |
50 文字以下 |
|
|
都道府県 ID
|
pref_id | integer |
登録されている状態コードのみ |
|
|
番地
|
address | string |
255 文字以下 |
|
|
URL
|
url | string |
255 文字以下 |
|
|
緯度
|
latitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
経度
|
longitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
リード ソース
|
lead_source_kbn_id | integer |
登録されているリード ソース ID のみ |
|
|
リード ソースの詳細
|
lead_source | string |
3000 文字以下 |
|
|
状態
|
status | integer |
1: アクティブ 2: 非アクティブ |
|
|
パブリック状態
|
open_status | integer |
1: 全体で公開 3: プライベート (彼の唯一) |
|
|
名刺所有者のユーザー ID
|
owner_user_id | integer |
登録されているユーザーの ID のみ |
|
|
その他の名刺所有者
|
owner_user | string |
255 文字以下 |
|
|
名刺交換日
|
trade_on | string |
yyyy / mm / dd |
|
|
メモ
|
note | string |
3000 文字以下 |
|
|
手書きのノート
|
direct_note | string |
3000 文字以下 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
id |
名刺を登録する
HotProfile に名刺を登録する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアントID
|
client_id | True | integer |
登録されているクライアントの ID のみ |
|
部門 ID
|
organization_id | integer |
登録されている部署の ID のみ |
|
|
Surname
|
family_name | True | string |
100 文字以下 |
|
名前
|
first_name | string |
100 文字以下 |
|
|
姓 (かな)
|
family_name_kana | string |
100 文字以下 |
|
|
名前 (かな)
|
first_name_kana | string |
100 文字以下 |
|
|
電話番号
|
tel | string |
100 文字以下 |
|
|
内線番号
|
extension | integer |
最大 8 文字の整数 |
|
|
ファクシミリ
|
fax | string |
100 文字以下 |
|
|
メール アドレス
|
string |
200 文字以下 |
||
|
携帯電話番号
|
mobile_tel | string |
100 文字以下 |
|
|
モバイル電子メール アドレス
|
mobile_email | string |
100 文字以下 |
|
|
郵便番号
|
zip | string |
50 文字以下 |
|
|
都道府県 ID
|
pref_id | integer |
登録されている状態コードのみ |
|
|
番地
|
address | string |
255 文字以下 |
|
|
URL
|
url | string |
255 文字以下 |
|
|
緯度
|
latitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
経度
|
longitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
リード ソース
|
lead_source_kbn_id | integer |
登録されているリード ソース ID のみ |
|
|
リード ソースの詳細
|
lead_source | string |
3000 文字以下 |
|
|
状態
|
status | True | integer |
1: アクティブ 2: 非アクティブ |
|
パブリック状態
|
open_status | True | integer |
1: 全体で公開 3: プライベート (彼の唯一) |
|
名刺所有者のユーザー ID
|
owner_user_id | integer |
登録されているユーザーの ID のみ |
|
|
名刺所有者の名前
|
owner_user | string |
255 文字以下 |
|
|
名刺交換日
|
trade_on | string |
yyyy / mm / dd |
|
|
メモ
|
note | string |
3000 文字以下 |
|
|
手書きのノート
|
direct_note | string |
3000 文字以下 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
id |
潜在顧客を得る
HotProfile に登録された潜在顧客を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前 (姓)
|
search[family_name] | string |
部分一致 |
|
|
フル ネーム (名)
|
search[first_name] | string |
部分一致 |
|
|
クライアント名
|
search[client_name] | string |
部分一致 |
|
|
id search (~)
|
search[from_id] | integer |
指定した ID の後のデータを検索する |
|
|
id search (~ to)
|
search[to_id] | integer |
指定した ID までのデータを検索する |
|
|
並べ替えキー
|
order[key] | string |
(id、create_at、update_at) のいずれかを指定できます。 |
|
|
並べ替え
|
order[type] | string |
昇順: asc、降順: desc |
|
|
取得番号
|
page[display_number] | integer |
最大 100 (既定値: 20) |
|
|
ページ番号
|
page[number] | integer |
1 バイトの数値 (1 ~) |
|
|
日付項目形式指定オプション
|
page[date_format_option] | integer |
0:off または 1:on |
|
|
クライアントID
|
search[client_id] | integer |
部分一致 |
|
|
クライアント名 かな
|
search[client][name_kana] | string |
部分一致 |
|
|
クライアント名の省略形
|
search[client][name_disp] | string |
部分一致 |
|
|
販売員 ID
|
search[owner_user_id] | integer |
一致する |
|
|
Rights グループ
|
search[role_id] | integer |
一致する |
|
|
部門 ID
|
search[organization_id] | integer |
一致する |
|
|
組織名 (下部レイヤー)
|
search[organization_name] | string |
部分一致 |
|
|
組織名 (すべてのレベル)
|
search[organization_ancestry_all_name] | string |
部分一致 |
|
|
位置
|
search[post] | string |
部分一致 |
|
|
姓 かな
|
search[family_name_kana] | string |
部分一致 |
|
|
名前 かな
|
search[first_name_kana] | string |
部分一致 |
|
|
メルアド
|
search[email] | string |
部分一致 |
|
|
モバイル電子メール アドレス
|
search[mobile_email] | string |
部分一致 |
|
|
電話番号
|
search[tel] | string |
部分一致 |
|
|
電話番号 (内線番号)
|
search[extension] | string |
部分一致 |
|
|
ファクシミリ
|
search[fax] | string |
部分一致 |
|
|
携帯電話番号
|
search[mobile_tel] | string |
部分一致 |
|
|
郵便番号
|
search[zip] | string |
部分一致 |
|
|
県
|
search[pref] | string |
部分一致 |
|
|
番地
|
search[address] | string |
部分一致 |
|
|
URL
|
search[url] | string |
部分一致 |
|
|
入力日
|
search[from_created_on] | string |
エントリ日付> = 検索値の例) 2016/03/23 |
|
|
入力日
|
search[to_created_on] | string |
入力日付 <= 検索値の例) 2016/03/23 |
|
|
改築日
|
search[from_updated_on] | string |
日付> = 検索値の例) 2016/03/23 |
|
|
改築日
|
search[to_updated_on] | string |
日付 <= 検索値の例) 2016/03/23 |
|
|
改築日
|
search[from_datetime_updated_on] | string |
Date> = search value example) 2016/03/23 12:05:11 |
|
|
改築日
|
search[to_datetime_updated_on] | string |
日付 <= 検索値の例) 2016/03/23 12:05:11 |
|
|
情報取得日
|
search[from_trade_on] | string |
情報取得日> = 検索値の例) 2016/03/23 |
|
|
情報取得日
|
search[to_trade_on] | string |
情報取得日 <= 検索値の例) 2016/03/23 |
|
|
緯度
|
search[from_latitude] | integer |
Latitude <= search value example) 35.7150244 Search |
|
|
緯度
|
search[to_latitude] | integer |
Latitude <= search value example) 35.7150244 Search |
|
|
経度
|
search[from_longitude] | integer |
経度 <= 検索値の例) 139.7079309 |
|
|
経度
|
search[to_longitude] | integer |
経度 <= 検索値の例) 139.7079309 |
|
|
緯度
|
search[latitude] | string |
部分一致 |
|
|
経度
|
search[longitude] | string |
部分一致 |
|
|
読み取り状態
|
search[lead_status] | integer |
1: アクティブ、2: 非アクティブ |
|
|
リード ソース
|
search[lead_source_kbn_ids] | integer |
リード ソース分類 ID の検索 |
|
|
リード ソース (詳細)
|
search[lead_source] | string |
部分一致 |
|
|
重要なお客様
|
search[important_customer_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
エンド ユーザー
|
search[end_user_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
販売店舗
|
search[store_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
競合 他社
|
search[competitor_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
電子メール エラー
|
search[error_mail_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
電話番号エラー
|
search[error_tel_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
FAX 番号エラー
|
search[error_fax_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
アドレス エラー
|
search[error_address_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
電子メールの拒否
|
search[not_mail_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
通話拒否
|
search[not_tel_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
FAX 配信拒否
|
search[not_fax_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
DM配信拒否
|
search[not_dm_flg] | integer |
1:チェックはい 0: チェックなし |
|
|
メモ
|
search[note] | string |
部分一致 |
|
|
顧客ID
|
search[customer_id] | string |
部分一致 |
|
|
姓名
|
search[name] | string |
部分一致 |
|
|
潜在顧客 ID
|
search[ids] | string |
コンマ区切りで指定します。 (OR 検索) |
|
|
名刺の所有者
|
search[user_ids] | string |
コンマ区切りで指定します。 (OR 検索) |
|
|
単純検索
|
search[multiple] | string |
複数の検索単語をスペースで区切って指定できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
リード
|
leads | array of object |
リード |
|
番地
|
leads.address | string |
番地 |
|
番地 1
|
leads.address1 | string |
番地 1 |
|
番地 2
|
leads.address2 | string |
番地 2 |
|
番地 3
|
leads.address3 | string |
番地 3 |
|
クライアントID
|
leads.client_id | integer |
クライアントID |
|
クライアント名
|
leads.client_name | string |
クライアント名 |
|
競合 他社
|
leads.competitor_flg | string |
競合 他社 |
|
入力日
|
leads.created_at | string |
入力日 |
|
現在のページの番号
|
leads.current_number | integer |
現在のページの番号 |
|
顧客ID
|
leads.customer_id | string |
顧客ID |
|
1ページの取得数
|
leads.display_number | integer |
1ページの取得数 |
|
メール アドレス
|
leads.email | string |
メール アドレス |
|
エンド ユーザー
|
leads.end_user_flg | string |
エンド ユーザー |
|
アドレス エラー
|
leads.error_address_flg | string |
アドレス エラー |
|
FAX 番号エラー
|
leads.error_fax_flg | string |
FAX 番号エラー |
|
電子メール エラー
|
leads.error_mail_flg | string |
電子メール エラー |
|
電話番号エラー
|
leads.error_tel_flg | string |
電話番号エラー |
|
電話番号 (内線番号)
|
leads.extension | string |
電話番号 (内線番号) |
|
名前 (姓)
|
leads.family_name | string |
名前 (姓) |
|
姓 (かな)
|
leads.family_name_kana | string |
姓 (かな) |
|
ファクシミリ
|
leads.fax | string |
ファクシミリ |
|
フル ネーム (名)
|
leads.first_name | string |
フル ネーム (名) |
|
名前 (かな)
|
leads.first_name_kana | string |
名前 (かな) |
|
潜在顧客 ID
|
leads.id | integer |
潜在顧客 ID |
|
重要なお客様
|
leads.important_customer_flg | string |
重要なお客様 |
|
関心のある製品一覧
|
leads.interest_product_type_ids | array of integer |
関心のある製品一覧 |
|
利子製品名一覧
|
leads.interest_product_type_names | array of string |
利子製品名一覧 |
|
カスタム項目リスト
|
leads.items | array of string |
カスタム項目リスト |
|
カスタム項目ラベル
|
leads.itemslabel | string |
カスタム項目ラベル |
|
カスタム項目の値
|
leads.itemsvalue | string |
カスタム項目の値 |
|
緯度
|
leads.latitude | string |
緯度 |
|
リード ソース (詳細)
|
leads.lead_source | string |
リード ソース (詳細) |
|
リード ソース ID
|
leads.lead_source_kbn_id | integer |
リード ソース ID |
|
リード ソース
|
leads.lead_source_kbn_name | string |
リード ソース |
|
読み取り状態
|
leads.lead_status | integer |
読み取り状態 |
|
読み取り状態
|
leads.lead_status_name | string |
読み取り状態 |
|
経度
|
leads.longitude | string |
経度 |
|
モバイル電子メール アドレス
|
leads.mobile_email | string |
モバイル電子メール アドレス |
|
携帯電話番号
|
leads.mobile_tel | string |
携帯電話番号 |
|
姓名
|
leads.name | string |
姓名 |
|
Name Phonetic
|
leads.name_kana | string |
Name Phonetic |
|
DM配信拒否
|
leads.not_dm_flg | string |
DM配信拒否 |
|
FAX 配信拒否
|
leads.not_fax_flg | string |
FAX 配信拒否 |
|
電子メールの拒否
|
leads.not_mail_flg | string |
電子メールの拒否 |
|
通話拒否
|
leads.not_tel_flg | string |
通話拒否 |
|
メモ
|
leads.note | string |
メモ |
|
部門階層
|
leads.organization_hierarchy | array of string |
部門階層 |
|
組織 ID
|
leads.organization_id | integer |
組織 ID |
|
部署
|
leads.organization_name | string |
部署 |
|
販売員のユーザー ID
|
leads.owner_user_code | string |
販売員のユーザー ID |
|
販売員のユーザー管理 ID
|
leads.owner_user_id | integer |
販売員のユーザー管理 ID |
|
営業担当者
|
leads.owner_user_name | string |
営業担当者 |
|
位置
|
leads.post | string |
位置 |
|
県
|
leads.pref | string |
県 |
|
都道府県 ID
|
leads.pref_id | integer |
都道府県 ID |
|
販売店舗
|
leads.store_flg | string |
販売店舗 |
|
タグ ID リスト
|
leads.tag_ids | array of integer |
タグ ID リスト |
|
タグ リスト
|
leads.tags | array of string |
タグ リスト |
|
電話番号
|
leads.tel | string |
電話番号 |
|
検索結果の数
|
leads.total_count | integer |
検索結果の数 |
|
ページの合計数
|
leads.total_number | integer |
ページの合計数 |
|
情報取得日
|
leads.trade_on | string |
情報取得日 |
|
改築日
|
leads.updated_at | string |
改築日 |
|
URL
|
leads.url | string |
URL |
|
名刺所有者リスト
|
leads.user_names | array of string |
名刺所有者リスト |
|
郵便番号
|
leads.zip | string |
郵便番号 |
|
現在のページの番号
|
pages.current_number | integer |
現在のページの番号 |
|
1ページの取得数
|
pages.display_number | integer |
1ページの取得数 |
|
検索結果の数
|
pages.total_count | integer |
検索結果の数 |
|
ページの合計数
|
pages.total_number | integer |
ページの合計数 |
潜在顧客を更新する
HotProfile でリードを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
潜在顧客 ID
|
id | True | integer |
登録されているリードの ID のみ |
|
クライアントID
|
client_id | True | integer |
登録されているクライアントの ID のみ |
|
部門 ID
|
organization_id | integer |
登録されているクライアントの ID のみ |
|
|
位置
|
post | string |
255 文字以下 |
|
|
Surname
|
family_name | string |
100 文字以下 |
|
|
名前
|
first_name | string |
100 文字以下 |
|
|
姓 (かな)
|
family_name_kana | string |
100 文字以下 |
|
|
名前 (かな)
|
first_name_kana | string |
100 文字以下 |
|
|
電話番号
|
tel | string |
100 文字以下 |
|
|
内線番号
|
extension | integer |
整数のみ?8 文字以下 |
|
|
ファクシミリ
|
fax | string |
100 文字以下 |
|
|
メール アドレス
|
string |
200 文字以下 |
||
|
携帯電話番号
|
mobile_tel | string |
100 文字以下 |
|
|
モバイル電子メール アドレス
|
mobile_email | string |
100 文字以下 |
|
|
郵便番号
|
zip | string |
50 文字以下 |
|
|
都道府県コード
|
pref_id | integer |
都道府県の選択に存在する ID のみ |
|
|
番地
|
address | string |
255 文字以下 |
|
|
URL
|
url | string |
255 文字以下 |
|
|
読み取り状態
|
lead_status | integer |
読み取り状態の選択に存在する ID のみ |
|
|
緯度
|
latitude | integer |
??? タグ自体の名前ではなく、タグ タグ 1 がある場合は、ID を指定します。 |
|
|
経度
|
longitude | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
リード ソース ID
|
lead_source_kbn_id | integer |
整数 3 桁 (10 進 14 桁以内) |
|
|
リード ソースの詳細
|
lead_source | string |
潜在顧客管理 - 選択肢管理のリード ソースに登録されている ID のみ |
|
|
メモ
|
note | string |
3000 文字以下 |
|
|
電子メール エラー
|
error_mail_flg | boolean |
オプション管理 - 製品のみに関心のあるリード管理に登録されている ID |
|
|
電話番号エラー
|
error_tel_flg | boolean |
フラグ |
|
|
FAX 番号エラー
|
error_fax_flg | boolean |
フラグ |
|
|
アドレス エラー
|
error_address_flg | boolean |
フラグ |
|
|
電子メールの拒否
|
not_mail_flg | boolean |
フラグ |
|
|
通話拒否
|
not_tel_flg | boolean |
フラグ |
|
|
FAX 配信拒否
|
not_fax_flg | boolean |
フラグ |
|
|
DM配信拒否
|
not_dm_flg | boolean |
フラグ |
|
|
競合 他社
|
competitor_flg | boolean |
フラグ |
|
|
重要なお客様
|
important_customer_flg | boolean |
フラグ |
|
|
エンド ユーザー
|
end_user_flg | boolean |
フラグ |
|
|
販売店舗
|
store_flg | boolean |
フラグ |
|
|
顧客ID
|
customer_id | string |
フラグ |
|
|
販売員ユーザー ID
|
owner_user_id | string |
255 文字以下 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
id |