HotProfile (Preview)
![](https://connectoricons-prod.azureedge.net/u/shgogna/version-mismatches-special-train/1.0.1670.3520/hotprofile/icon.png)
HotProfile automates management of business card data conversion data.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Hotprofile suport |
URL | https://www.hammock.jp/hpr/support/ |
[email protected] |
Connector Metadata | |
---|---|
Publisher | Hammock corporation |
Website | https://hammock.hotprofile.biz/ |
Privacy policy | https://www.hammock.jp/securitypolicy/privacypolicy.html |
Categories | Sales and CRM |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
HotProfile API key | securestring | HotProfile API key | True |
your HotProfile URL Instance | string | The url to your HotProfile instance eg https://example.hot-profile.com/ -> <example.hot-profile.com> | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Get business cards |
Get business cards registered in HotProfile |
Get clients |
Get clients registered in HotProfile |
Get leads |
Get leads registered in HotProfile |
Register a business card |
Register a business card in HotProfile |
Register a client |
Register a client to HotProfile |
Register a lead |
Register a lead to HotProfile |
Update a business card |
Update a business card in HotProfile |
Update a client |
Update a client in HotProfile |
Update a lead |
Update a lead in HotProfile |
Get business cards
Get business cards registered in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
page number
|
page[number] | integer |
Single-byte numbers (1 ~) |
|
Get the number of 1 page
|
page[display_number] | integer |
Single-byte number (1 to 1000) |
|
Date item format specified option
|
page[date_format_option] | boolean |
true or false |
|
Items to be sorted
|
order[key] | string |
id, trade_on, updated_at |
|
Sort direction
|
order[type] | string |
asc or desc |
|
Name (last name)
|
search[family_name] | string |
Partial Match |
|
Full name (first name)
|
search[first_name] | string |
Partial Match |
|
Last name (Kana)
|
search[family_name_kana] | string |
Partial Match |
|
Name (Kana)
|
search[first_name_kana] | string |
Partial Match |
|
client name
|
search[client_name] | string |
Partial Match |
|
Business card exchange date (from search)
|
search[from_trade_on] | string |
yyyy / mm / dd |
|
Business card exchange date (to search)
|
search[to_trade_on] | string |
yyyy / mm / dd |
|
Date (from search)
|
search[from_updated_on] | string |
yyyy / mm / dd |
|
Update date (to search)
|
search[to_updated_on] | string |
yyyy / mm / dd |
|
Input date (from search)
|
search[from_created_on] | string |
yyyy / mm / dd |
|
Input date (to search)
|
search[to_created_on] | string |
yyyy / mm / dd |
|
Department
|
search[organization_ancestry_all_name] | string |
Partial Match |
|
Position
|
search[post] | string |
Partial Match |
|
phone number
|
search[tel] | string |
Partial Match |
|
FAX
|
search[fax] | string |
Partial Match |
|
cell phone number
|
search[mobile_tel] | string |
Partial Match |
|
mail address
|
search[email] | string |
Partial Match |
|
Mobile e-mail address
|
search[mobile_email] | string |
Partial Match |
|
group
|
search[role_id] | integer |
Authority group ID |
|
Postal code
|
search[zip] | string |
Partial Match |
|
Street address
|
search[address] | string |
Partial Match |
|
URL
|
search[url] | string |
Partial Match |
|
Memo
|
search[note] | string |
Partial Match |
|
Handwritten notes
|
search[direct_note] | string |
Partial Match |
|
Lead source details
|
search[lead_source] | string |
Partial Match |
|
Inquiry number
|
search[request_key] | string |
Partial Match |
|
latitude
|
search[latitude] | integer |
Partial Match |
|
longitude
|
search[longitude] | integer |
Partial Match |
Returns
Name | Path | Type | Description |
---|---|---|---|
business_cards
|
business_cards | array of object |
business_cards |
Street address
|
business_cards.address | string |
Street address |
Street address1
|
business_cards.address1 | string |
Street address1 |
Street address2
|
business_cards.address2 | string |
Street address2 |
Street address3
|
business_cards.address3 | string |
Street address3 |
client name
|
business_cards.client_name | string |
client name |
input date
|
business_cards.created_at | string |
input date |
Handwritten notes
|
business_cards.direct_note | string |
Handwritten notes |
mail address
|
business_cards.email | string |
mail address |
FAX
|
business_cards.fax | string |
FAX |
Business card ID
|
business_cards.id | integer |
Business card ID |
latitude
|
business_cards.latitude | string |
latitude |
Lead source details
|
business_cards.lead_source | string |
Lead source details |
Lead Source
|
business_cards.lead_source_kbn_id | integer |
Lead Source |
longitude
|
business_cards.longitude | string |
longitude |
Mobile e-mail address
|
business_cards.mobile_email | string |
Mobile e-mail address |
cell phone number
|
business_cards.mobile_tel | string |
cell phone number |
Full name
|
business_cards.name | string |
Full name |
Name (Kana)
|
business_cards.name_kana | string |
Name (Kana) |
Memo
|
business_cards.note | string |
Memo |
Department
|
business_cards.organization_name | string |
Department |
Position
|
business_cards.post | string |
Position |
Prefectures
|
business_cards.pref_id | integer |
Prefectures |
Inquiry number
|
business_cards.request_key | string |
Inquiry number |
status
|
business_cards.status | integer |
status |
tag
|
business_cards.tag_ids | array of integer |
tag |
phone number
|
business_cards.tel | string |
phone number |
Business card exchange Date
|
business_cards.trade_on | string |
Business card exchange Date |
Date of renovation
|
business_cards.updated_at | string |
Date of renovation |
URL
|
business_cards.url | string |
URL |
Business card owner
|
business_cards.user_name | string |
Business card owner |
Postal code
|
business_cards.zip | string |
Postal code |
The number of the current page
|
pages.current_number | integer |
The number of the current page |
Number of acquisition of 1 page
|
pages.display_number | integer |
Number of acquisition of 1 page |
Of the number of search results
|
pages.total_count | integer |
Of the number of search results |
Total number of pages
|
pages.total_number | integer |
Total number of pages |
Get clients
Get clients registered in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
page number
|
page[number] | integer |
Single-byte numbers (1 ~) |
|
Get the number of 1 page
|
page[display_number] | integer |
Single-byte number (1 to 1000) |
|
Date item format specified option
|
page[date_format_option] | integer |
0:off or 1:on |
|
Items to be sorted
|
order[key] | string |
Over |
|
Sort direction
|
order[type] | string |
asc or desc |
|
Client ID (from search)
|
search[from_id] | integer |
id> = from_idfrom only be specified. |
|
Client ID (to search)
|
search[to_id] | integer |
id <= to_idto only be specified. |
|
client name
|
search[name] | string |
Partial Match |
|
Client Name Kana
|
search[name_kana] | string |
Partial Match |
|
abbreviation
|
search[name_disp] | string |
Partial Match |
|
Postal code
|
search[zip] | string |
Partial Match |
|
Street address
|
search[address] | string |
Partial Match |
|
latitude
|
search[latitude] | string |
Partial Match |
|
longitude
|
search[longitude] | string |
Partial Match |
|
Employer Identification Number
|
search[corporate_number] | string |
Partial Match |
|
Representative phone number
|
search[main_tel] | string |
Partial Match |
|
URL
|
search[url] | string |
Partial Match |
|
E-mail domain
|
search[mail_domain] | string |
Partial Match |
|
Memo
|
search[note] | string |
Partial Match |
|
Sales representative
|
search[user_ids] | integer |
Only the ID of the user who has been registered |
|
Client Name (second language)
|
search[name_sub] | string |
If the second language feature is enabled only |
|
Client Name Kana (second language)
|
search[name_kana_sub] | string |
If the second language feature is enabled only |
|
Postal code (second language)
|
search[zip_sub] | string |
If the second language feature is enabled only |
|
Address (second language)
|
search[address_sub] | string |
If the second language feature is enabled only |
|
State (second language)
|
search[pref_sub] | string |
If the second language feature is enabled only |
|
Input date (from search)
|
search[from_created_on] | string |
yyyy / mm / dd |
|
Input date (to search)
|
search[to_created_on] | string |
yyyy / mm / dd |
|
Date (from search)
|
search[from_updated_on] | string |
yyyy / mm / dd |
|
Update date (to search)
|
search[to_updated_on] | string |
yyyy / mm / dd |
|
Update date and time (from search)
|
search[from_datetime_updated_on] | string |
yyyy / mm / dd HH: mm: ss |
|
Update date and time (to search)
|
search[to_datetime_updated_on] | string |
yyyy / mm / dd HH: mm: ss |
Returns
Name | Path | Type | Description |
---|---|---|---|
clients
|
clients | array of object |
clients |
Company ID
|
clients.id | integer |
Company ID |
company name
|
clients.name | string |
company name |
Company Name Kana
|
clients.name_kana | string |
Company Name Kana |
Company name abbreviation
|
clients.name_disp | string |
Company name abbreviation |
Postal code
|
clients.zip | string |
Postal code |
Prefectures
|
clients.pref | string |
Prefectures |
Street address
|
clients.address | string |
Street address |
Street address1
|
clients.address1 | string |
Street address1 |
Street address2
|
clients.address2 | string |
Street address2 |
Street address3
|
clients.address3 | string |
Street address3 |
latitude
|
clients.latitude | string |
latitude |
longitude
|
clients.longitude | string |
longitude |
Type of industry
|
clients.business_category_kbn | string |
Type of industry |
number of employees
|
clients.worker_number_kbn | string |
number of employees |
Capital stock
|
clients.capital_kbn | string |
Capital stock |
Listed division
|
clients.ipo_kbn | string |
Listed division |
Last year sales
|
clients.sales_last_year | string |
Last year sales |
Representative phone number
|
clients.main_tel | string |
Representative phone number |
URL
|
clients.url | string |
URL |
E-mail domain
|
clients.mail_domain | string |
E-mail domain |
Memo
|
clients.note | string |
Memo |
Sales representative
|
clients.user_name | string |
Sales representative |
Salesperson ID
|
clients.user_code | string |
Salesperson ID |
Employer Identification Number
|
clients.corporate_number | integer |
Employer Identification Number |
input date
|
clients.created_at | string |
input date |
Date of renovation
|
clients.updated_at | string |
Date of renovation |
Custom item list
|
clients.items | array of string |
Custom item list |
Custom item label
|
clients.itemslabel | string |
Custom item label |
The value of the custom items
|
clients.itemsvalue | string |
The value of the custom items |
Of the number of search results
|
clients.total_count | integer |
Of the number of search results |
Total number of pages
|
clients.total_number | integer |
Total number of pages |
The number of the current page
|
clients.current_number | integer |
The number of the current page |
Number of acquisition of 1 page
|
clients.display_number | integer |
Number of acquisition of 1 page |
The number of the current page
|
pages.current_number | integer |
The number of the current page |
Number of acquisition of 1 page
|
pages.display_number | integer |
Number of acquisition of 1 page |
Of the number of search results
|
pages.total_count | integer |
Of the number of search results |
Total number of pages
|
pages.total_number | integer |
Total number of pages |
Get leads
Get leads registered in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name (last name)
|
search[family_name] | string |
Partial Match |
|
Full name (first name)
|
search[first_name] | string |
Partial Match |
|
client name
|
search[client_name] | string |
Partial Match |
|
id search (from ~)
|
search[from_id] | integer |
Search for data after the specified id |
|
id search (~ to)
|
search[to_id] | integer |
Search for data up to the specified id |
|
Sort key
|
order[key] | string |
Can be either a (id, create_at, update_at) |
|
sort
|
order[type] | string |
Ascending order: asc, descending order: desc |
|
Acquisition number
|
page[display_number] | integer |
Up to 100 (Default: 20) |
|
page number
|
page[number] | integer |
Single-byte numbers (1 ~) |
|
Date item format specified option
|
page[date_format_option] | integer |
0:off or 1:on |
|
Client ID
|
search[client_id] | integer |
Partial Match |
|
Client Name Kana
|
search[client][name_kana] | string |
Partial Match |
|
Client name abbreviation
|
search[client][name_disp] | string |
Partial Match |
|
Salesperson ID
|
search[owner_user_id] | integer |
Match |
|
Rights group
|
search[role_id] | integer |
Match |
|
Department ID
|
search[organization_id] | integer |
Match |
|
Organization name (bottom layer)
|
search[organization_name] | string |
Partial Match |
|
Organization name (all levels)
|
search[organization_ancestry_all_name] | string |
Partial Match |
|
Position
|
search[post] | string |
Partial Match |
|
Last name Kana
|
search[family_name_kana] | string |
Partial Match |
|
Name Kana
|
search[first_name_kana] | string |
Partial Match |
|
e-mail address
|
search[email] | string |
Partial Match |
|
Mobile e-mail address
|
search[mobile_email] | string |
Partial Match |
|
phone number
|
search[tel] | string |
Partial Match |
|
Telephone number (extension number)
|
search[extension] | string |
Partial Match |
|
FAX
|
search[fax] | string |
Partial Match |
|
cell phone number
|
search[mobile_tel] | string |
Partial Match |
|
Postal code
|
search[zip] | string |
Partial Match |
|
Prefectures
|
search[pref] | string |
Partial Match |
|
Street address
|
search[address] | string |
Partial Match |
|
URL
|
search[url] | string |
Partial Match |
|
input date
|
search[from_created_on] | string |
Entry Date> = search value example) 2016/03/23 |
|
input date
|
search[to_created_on] | string |
Input Date <= search value example) 2016/03/23 |
|
Date of renovation
|
search[from_updated_on] | string |
Date> = search value example) 2016/03/23 |
|
Date of renovation
|
search[to_updated_on] | string |
Date <= search value example) 2016/03/23 |
|
Date of renovation
|
search[from_datetime_updated_on] | string |
Date> = search value example) 2016/03/23 12:05:11 |
|
Date of renovation
|
search[to_datetime_updated_on] | string |
Date <= search value example) 2016/03/23 12:05:11 |
|
Information acquisition date
|
search[from_trade_on] | string |
Information acquisition date> = search value example) 2016/03/23 |
|
Information acquisition date
|
search[to_trade_on] | string |
Information acquisition date <= search value example) 2016/03/23 |
|
latitude
|
search[from_latitude] | integer |
Latitude <= search value example) 35.7150244 Search |
|
latitude
|
search[to_latitude] | integer |
Latitude <= search value example) 35.7150244 Search |
|
longitude
|
search[from_longitude] | integer |
Longitude <= search value example) 139.7079309 |
|
longitude
|
search[to_longitude] | integer |
Longitude <= search value example) 139.7079309 |
|
latitude
|
search[latitude] | string |
Partial Match |
|
longitude
|
search[longitude] | string |
Partial Match |
|
Read status
|
search[lead_status] | integer |
1: active, 2: Non-active |
|
Lead Source
|
search[lead_source_kbn_ids] | integer |
Lead source classification ID search |
|
Lead Source (details)
|
search[lead_source] | string |
Partial Match |
|
Important customer
|
search[important_customer_flg] | integer |
1: Check Yes 0: no check |
|
End-user
|
search[end_user_flg] | integer |
1: Check Yes 0: no check |
|
Sales outlet
|
search[store_flg] | integer |
1: Check Yes 0: no check |
|
Competitors
|
search[competitor_flg] | integer |
1: Check Yes 0: no check |
|
E-mail error
|
search[error_mail_flg] | integer |
1: Check Yes 0: no check |
|
Phone number error
|
search[error_tel_flg] | integer |
1: Check Yes 0: no check |
|
FAX number error
|
search[error_fax_flg] | integer |
1: Check Yes 0: no check |
|
Address error
|
search[error_address_flg] | integer |
1: Check Yes 0: no check |
|
E-mail rejection
|
search[not_mail_flg] | integer |
1: Check Yes 0: no check |
|
The call rejection
|
search[not_tel_flg] | integer |
1: Check Yes 0: no check |
|
FAX delivery refusal
|
search[not_fax_flg] | integer |
1: Check Yes 0: no check |
|
DM delivery refusal
|
search[not_dm_flg] | integer |
1: Check Yes 0: no check |
|
Memo
|
search[note] | string |
Partial Match |
|
Customer ID
|
search[customer_id] | string |
Partial Match |
|
Full name
|
search[name] | string |
Partial Match |
|
Lead ID
|
search[ids] | string |
Specified in the comma-delimited. (OR search) |
|
Business card owner
|
search[user_ids] | string |
Specified in the comma-delimited. (OR search) |
|
Simple Search
|
search[multiple] | string |
You can specify multiple search words separated by spaces. |
Returns
Name | Path | Type | Description |
---|---|---|---|
leads
|
leads | array of object |
leads |
Street address
|
leads.address | string |
Street address |
Street address1
|
leads.address1 | string |
Street address1 |
Street address2
|
leads.address2 | string |
Street address2 |
Street address3
|
leads.address3 | string |
Street address3 |
Client ID
|
leads.client_id | integer |
Client ID |
client name
|
leads.client_name | string |
client name |
Competitors
|
leads.competitor_flg | string |
Competitors |
input date
|
leads.created_at | string |
input date |
The number of the current page
|
leads.current_number | integer |
The number of the current page |
Customer ID
|
leads.customer_id | string |
Customer ID |
Number of acquisition of 1 page
|
leads.display_number | integer |
Number of acquisition of 1 page |
mail address
|
leads.email | string |
mail address |
End-user
|
leads.end_user_flg | string |
End-user |
Address error
|
leads.error_address_flg | string |
Address error |
FAX number error
|
leads.error_fax_flg | string |
FAX number error |
E-mail error
|
leads.error_mail_flg | string |
E-mail error |
Phone number error
|
leads.error_tel_flg | string |
Phone number error |
Telephone number (extension number)
|
leads.extension | string |
Telephone number (extension number) |
Name (Last name)
|
leads.family_name | string |
Name (Last name) |
Last name (Kana)
|
leads.family_name_kana | string |
Last name (Kana) |
FAX
|
leads.fax | string |
FAX |
Full name (first name)
|
leads.first_name | string |
Full name (first name) |
Name (Kana)
|
leads.first_name_kana | string |
Name (Kana) |
Lead ID
|
leads.id | integer |
Lead ID |
Important customer
|
leads.important_customer_flg | string |
Important customer |
Interested Products List
|
leads.interest_product_type_ids | array of integer |
Interested Products List |
Interest Product Name List
|
leads.interest_product_type_names | array of string |
Interest Product Name List |
Custom item list
|
leads.items | array of string |
Custom item list |
Custom item label
|
leads.itemslabel | string |
Custom item label |
The value of the custom items
|
leads.itemsvalue | string |
The value of the custom items |
latitude
|
leads.latitude | string |
latitude |
Lead Source (details)
|
leads.lead_source | string |
Lead Source (details) |
Lead Source ID
|
leads.lead_source_kbn_id | integer |
Lead Source ID |
Lead Source
|
leads.lead_source_kbn_name | string |
Lead Source |
Read status
|
leads.lead_status | integer |
Read status |
Read status
|
leads.lead_status_name | string |
Read status |
longitude
|
leads.longitude | string |
longitude |
Mobile e-mail address
|
leads.mobile_email | string |
Mobile e-mail address |
cell phone number
|
leads.mobile_tel | string |
cell phone number |
Full name
|
leads.name | string |
Full name |
Name Phonetic
|
leads.name_kana | string |
Name Phonetic |
DM delivery refusal
|
leads.not_dm_flg | string |
DM delivery refusal |
FAX delivery refusal
|
leads.not_fax_flg | string |
FAX delivery refusal |
E-mail rejection
|
leads.not_mail_flg | string |
E-mail rejection |
The call rejection
|
leads.not_tel_flg | string |
The call rejection |
Memo
|
leads.note | string |
Memo |
Department hierarchy
|
leads.organization_hierarchy | array of string |
Department hierarchy |
Organization ID
|
leads.organization_id | integer |
Organization ID |
Department
|
leads.organization_name | string |
Department |
User ID of the salesperson
|
leads.owner_user_code | string |
User ID of the salesperson |
User management ID of the salesperson
|
leads.owner_user_id | integer |
User management ID of the salesperson |
Sales representative
|
leads.owner_user_name | string |
Sales representative |
Position
|
leads.post | string |
Position |
Prefectures
|
leads.pref | string |
Prefectures |
State ID
|
leads.pref_id | integer |
State ID |
Sales outlet
|
leads.store_flg | string |
Sales outlet |
Tag ID List
|
leads.tag_ids | array of integer |
Tag ID List |
Tag List
|
leads.tags | array of string |
Tag List |
phone number
|
leads.tel | string |
phone number |
Of the number of search results
|
leads.total_count | integer |
Of the number of search results |
Total number of pages
|
leads.total_number | integer |
Total number of pages |
Information acquisition date
|
leads.trade_on | string |
Information acquisition date |
Date of renovation
|
leads.updated_at | string |
Date of renovation |
URL
|
leads.url | string |
URL |
Business card owner List
|
leads.user_names | array of string |
Business card owner List |
Postal code
|
leads.zip | string |
Postal code |
The number of the current page
|
pages.current_number | integer |
The number of the current page |
Number of acquisition of 1 page
|
pages.display_number | integer |
Number of acquisition of 1 page |
Of the number of search results
|
pages.total_count | integer |
Of the number of search results |
Total number of pages
|
pages.total_number | integer |
Total number of pages |
Register a business card
Register a business card in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Client ID
|
client_id | True | integer |
Only the ID of the client that is registered |
Department ID
|
organization_id | integer |
Only the ID of the department that are registered |
|
Surname
|
family_name | True | string |
100 characters or less |
Name
|
first_name | string |
100 characters or less |
|
Last name (Kana)
|
family_name_kana | string |
100 characters or less |
|
Name (Kana)
|
first_name_kana | string |
100 characters or less |
|
phone number
|
tel | string |
100 characters or less |
|
Extension number
|
extension | integer |
Integer only up to 8 characters |
|
FAX
|
fax | string |
100 characters or less |
|
mail address
|
string |
200 characters or less |
||
cell phone number
|
mobile_tel | string |
100 characters or less |
|
Mobile e-mail address
|
mobile_email | string |
100 characters or less |
|
Postal code
|
zip | string |
50 characters or less |
|
State ID
|
pref_id | integer |
Only the state code that is registered |
|
Street address
|
address | string |
255 characters or less |
|
URL
|
url | string |
255 characters or less |
|
latitude
|
latitude | integer |
Integer 3 digits, within decimal 14 digits |
|
longitude
|
longitude | integer |
Integer 3 digits, within decimal 14 digits |
|
Lead Source
|
lead_source_kbn_id | integer |
Only lead source ID that is registered |
|
Lead source details
|
lead_source | string |
3000 characters or less |
|
status
|
status | True | integer |
1: Active 2: Inactive |
Public status
|
open_status | True | integer |
1: Published in the entire 3: Private (his only) |
Business card owner user ID
|
owner_user_id | integer |
Only the ID of the user who has been registered |
|
Business card owner's name
|
owner_user | string |
255 characters or less |
|
Business card exchange Date
|
trade_on | string |
yyyy / mm / dd |
|
Memo
|
note | string |
3000 characters or less |
|
Handwritten notes
|
direct_note | string |
3000 characters or less |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
id |
Register a client
Register a client to HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
client name
|
name | True | string |
255 characters or less |
Client Name Kana
|
name_kana | string |
255 characters or less |
|
Client name abbreviation
|
name_disp | True | string |
255 characters or less |
Postal code
|
zip | string |
100 characters or less |
|
Prefectures
|
pref_id | integer |
Only the state code that is registered |
|
Street address
|
address | string |
255 characters or less |
|
latitude
|
latitude | integer |
Integer 3 digits, within decimal 14 digits |
|
longitude
|
longitude | integer |
Integer 3 digits, within decimal 14 digits |
|
Type of industry
|
business_category_kbn | integer |
Only industry segment ID that is registered |
|
number of employees
|
worker_number_kbn | integer |
Only the classification ID number of employees that are registered |
|
Capital stock
|
capital_kbn | integer |
Only capital classification ID that is registered |
|
Listed division
|
ipo_kbn | integer |
Only listed classification ID that is registered |
|
Last year sales
|
sales_last_year | string |
255 characters or less |
|
Representative phone number
|
main_tel | string |
255 characters or less |
|
URL
|
url | string |
255 characters or less |
|
E-mail domain
|
mail_domain | string |
255 characters or less |
|
Salesperson user ID
|
user_id | integer |
Only the ID of the user who has been registered |
|
Memo
|
note | string |
3000 characters or less |
|
Client Name (second language)
|
name_sub | string |
255 characters or less |
|
Client Name Kana (second language)
|
name_kana_sub | string |
255 characters or less |
|
Postal code (second language)
|
zip_sub | string |
100 characters or less |
|
Address (second language)
|
address_sub | string |
255 characters or less |
|
State (second language)
|
pref_sub | string |
255 characters or less |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
id |
Register a lead
Register a lead to HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Client ID
|
client_id | True | integer |
Only the ID of the client that is registered |
Surname
|
family_name | True | string |
100 characters or less |
Name
|
first_name | string |
100 characters or less |
|
Last name (Kana)
|
family_name_kana | string |
100 characters or less |
|
Name (Kana)
|
first_name_kana | string |
100 characters or less |
|
Department ID
|
organization_id | integer |
Only the ID of the client that is registered |
|
Position
|
post | string |
255 characters or less |
|
phone number
|
tel | string |
100 characters or less |
|
Extension number
|
extension | integer |
Integer only up to 8 characters |
|
FAX
|
fax | string |
100 characters or less |
|
mail address
|
string |
200 characters or less |
||
cell phone number
|
mobile_tel | string |
100 characters or less |
|
Mobile e-mail address
|
mobile_email | string |
100 characters or less |
|
Postal code
|
zip | string |
50 characters or less |
|
Prefecture code
|
pref_id | integer |
Only ID that exists in the choice of prefecture |
|
Street address
|
address | string |
255 characters or less |
|
URL
|
url | string |
255 characters or less |
|
Read status
|
lead_status | integer |
Only ID that exists in the choice of read status |
|
latitude
|
latitude | integer |
Integer 3 digits, within decimal 14 digits |
|
longitude
|
longitude | integer |
Integer 3 digits, within decimal 14 digits |
|
Lead Source ID
|
lead_source_kbn_id | integer |
Lead Management - lead source of the choices management only ID that is registered in the |
|
Lead source details
|
lead_source | string |
3000 characters or less |
|
Memo
|
note | string |
3000 characters or less |
|
E-mail error
|
error_mail_flg | boolean |
flag |
|
Phone number error
|
error_tel_flg | boolean |
flag |
|
FAX number error
|
error_fax_flg | boolean |
flag |
|
Address error
|
error_address_flg | boolean |
flag |
|
E-mail rejection
|
not_mail_flg | boolean |
flag |
|
The call rejection
|
not_tel_flg | boolean |
flag |
|
FAX delivery refusal
|
not_fax_flg | boolean |
flag |
|
DM delivery refusal
|
not_dm_flg | boolean |
flag |
|
Competitors
|
competitor_flg | boolean |
flag |
|
Important customer
|
important_customer_flg | boolean |
flag |
|
End-user
|
end_user_flg | boolean |
flag |
|
Sales outlet
|
store_flg | boolean |
flag |
|
Customer ID
|
customer_id | string |
255 characters or less |
|
Salesperson user ID
|
owner_user_id | string |
Only the ID of the user who is registered |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | integer |
ID |
Update a business card
Update a business card in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Business card ID
|
id | True | integer |
Only the ID of the business cards that are registered |
Client ID
|
client_id | True | integer |
Only the ID of the client that is registered |
Department ID
|
organization_id | integer |
Only the ID of the department that are registered |
|
Surname
|
family_name | string |
100 characters or less |
|
Name
|
first_name | string |
100 characters or less |
|
Last name (Kana)
|
family_name_kana | string |
100 characters or less |
|
Name (Kana)
|
first_name_kana | string |
100 characters or less |
|
phone number
|
tel | string |
100 characters or less |
|
Extension number
|
extension | integer |
Integer only up to 8 characters |
|
FAX
|
fax | string |
100 characters or less |
|
mail address
|
string |
200 characters or less |
||
cell phone number
|
mobile_tel | string |
100 characters or less |
|
Mobile e-mail address
|
mobile_email | string |
100 characters or less |
|
Postal code
|
zip | string |
50 characters or less |
|
State ID
|
pref_id | integer |
Only the state code that is registered |
|
Street address
|
address | string |
255 characters or less |
|
URL
|
url | string |
255 characters or less |
|
latitude
|
latitude | integer |
Integer 3 digits, within decimal 14 digits |
|
longitude
|
longitude | integer |
Integer 3 digits, within decimal 14 digits |
|
Lead Source
|
lead_source_kbn_id | integer |
Only lead source ID that is registered |
|
Lead source details
|
lead_source | string |
3000 characters or less |
|
status
|
status | integer |
1: Active 2: Inactive |
|
Public status
|
open_status | integer |
1: Published in the entire 3: Private (his only) |
|
Business card owner user ID
|
owner_user_id | integer |
Only the ID of the user who has been registered |
|
Other business card owner
|
owner_user | string |
255 characters or less |
|
Business card exchange Date
|
trade_on | string |
yyyy / mm / dd |
|
Memo
|
note | string |
3000 characters or less |
|
Handwritten notes
|
direct_note | string |
3000 characters or less |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
id |
Update a client
Update a client in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Client ID
|
id | True | integer |
Only the ID of the client that is registered |
client name
|
name | string |
255 characters or less |
|
Client Name Kana
|
name_kana | string |
255 characters or less |
|
Client name abbreviation
|
name_disp | string |
255 characters or less |
|
Postal code
|
zip | string |
100 characters or less |
|
Prefectures
|
pref_id | integer |
Only the state code that is registered |
|
Street address
|
address | string |
255 characters or less |
|
latitude
|
latitude | integer |
Integer 3 digits, within decimal 14 digits |
|
longitude
|
longitude | integer |
Integer 3 digits, within decimal 14 digits |
|
Type of industry
|
business_category_kbn | integer |
Only industry segment ID that is registered |
|
number of employees
|
worker_number_kbn | integer |
Only the classification ID number of employees that are registered |
|
Capital stock
|
capital_kbn | integer |
Only capital classification ID that is registered |
|
Listed division
|
ipo_kbn | integer |
Only listed classification ID that is registered |
|
Last year sales
|
sales_last_year | string |
255 characters or less |
|
Representative phone number
|
main_tel | string |
255 characters or less |
|
URL
|
url | string |
255 characters or less |
|
E-mail domain
|
mail_domain | string |
255 characters or less |
|
Salesperson user ID
|
user_id | integer |
Only the ID of the user who has been registered |
|
Memo
|
note | string |
3000 characters or less |
|
Client Name (second language)
|
name_sub | string |
255 characters or less |
|
Client Name Kana (second language)
|
name_kana_sub | string |
255 characters or less |
|
Postal code (second language)
|
zip_sub | string |
100 characters or less |
|
Address (second language)
|
address_sub | string |
255 characters or less |
|
State (second language)
|
pref_sub | string |
255 characters or less |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
id |
Update a lead
Update a lead in HotProfile
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Lead ID
|
id | True | integer |
Only the ID of the lead that has been registered |
Client ID
|
client_id | True | integer |
Only the ID of the client that is registered |
Department ID
|
organization_id | integer |
Only the ID of the client that is registered |
|
Position
|
post | string |
255 characters or less |
|
Surname
|
family_name | string |
100 characters or less |
|
Name
|
first_name | string |
100 characters or less |
|
Last name (Kana)
|
family_name_kana | string |
100 characters or less |
|
Name (Kana)
|
first_name_kana | string |
100 characters or less |
|
phone number
|
tel | string |
100 characters or less |
|
Extension number
|
extension | integer |
Integer only?8 characters or less |
|
FAX
|
fax | string |
100 characters or less |
|
mail address
|
string |
200 characters or less |
||
cell phone number
|
mobile_tel | string |
100 characters or less |
|
Mobile e-mail address
|
mobile_email | string |
100 characters or less |
|
Postal code
|
zip | string |
50 characters or less |
|
Prefecture code
|
pref_id | integer |
Only ID that exists in the choice of prefecture |
|
Street address
|
address | string |
255 characters or less |
|
URL
|
url | string |
255 characters or less |
|
Read status
|
lead_status | integer |
Only ID that exists in the choice of read status |
|
latitude
|
latitude | integer |
??? If there is a tag tag 1, rather than the name of the tag itself, specify the ID |
|
longitude
|
longitude | integer |
Integer 3 digits, within decimal 14 digits |
|
Lead Source ID
|
lead_source_kbn_id | integer |
Integer 3 digits, within decimal 14 digits |
|
Lead source details
|
lead_source | string |
Lead Management - lead source of the choices management only ID that is registered in the |
|
Memo
|
note | string |
3000 characters or less |
|
E-mail error
|
error_mail_flg | boolean |
Option management - ID that is registered in the Lead Management interested in products only |
|
Phone number error
|
error_tel_flg | boolean |
flag |
|
FAX number error
|
error_fax_flg | boolean |
flag |
|
Address error
|
error_address_flg | boolean |
flag |
|
E-mail rejection
|
not_mail_flg | boolean |
flag |
|
The call rejection
|
not_tel_flg | boolean |
flag |
|
FAX delivery refusal
|
not_fax_flg | boolean |
flag |
|
DM delivery refusal
|
not_dm_flg | boolean |
flag |
|
Competitors
|
competitor_flg | boolean |
flag |
|
Important customer
|
important_customer_flg | boolean |
flag |
|
End-user
|
end_user_flg | boolean |
flag |
|
Sales outlet
|
store_flg | boolean |
flag |
|
Customer ID
|
customer_id | string |
flag |
|
Salesperson user ID
|
owner_user_id | string |
255 characters or less |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | integer |
id |