Connectors Reference
HotProfile automates management of business card data conversion data.
|
Status: Preview |
Tier: Premium |
Version: 1.8.0 |
|
Name |
Summary |
|
Register a business card |
|
|
Get business cards |
|
|
Update a business card |
|
|
Register a client |
|
|
Get clients |
|
|
Update a client |
|
|
Register a lead |
|
|
Get leads |
|
|
Update a lead |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Register a business card
Description: Register a business card in HotProfile
Syntax:
HotProfile.Action_create_business_card (integer client_id, [Optional]integer organization_id, string family_name, [Optional]string first_name, [Optional]string family_name_kana, [Optional]string first_name_kana, [Optional]string tel, [Optional]integer extension, [Optional]string fax, [Optional]string email, [Optional]string mobile_tel, [Optional]string mobile_email, [Optional]string zip, [Optional]integer pref_id, [Optional]string address, [Optional]string url, [advanced][Optional]integer latitude, [advanced][Optional]integer longitude, [advanced][Optional]integer lead_source_kbn_id, [advanced][Optional]string lead_source, integer status, integer open_status, [Optional]integer owner_user_id, [Optional]string owner_user, [Optional]string trade_on, [Optional]string note, [advanced][Optional]string direct_note)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
client_id |
integer (Client ID) |
Only the ID of the client that is registered |
True |
|
|
organization_id |
integer (Department ID) |
Only the ID of the department that are registered |
False |
|
|
family_name |
string (Surname) |
100 characters or less |
True |
|
|
first_name |
string (Name) |
100 characters or less |
False |
|
|
family_name_kana |
string (Last name (Kana)) |
100 characters or less |
False |
|
|
first_name_kana |
string (Name (Kana)) |
100 characters or less |
False |
|
|
tel |
string (phone number) |
100 characters or less |
False |
|
|
extension |
integer (Extension number) |
Integer only up to 8 characters |
False |
|
|
fax |
string (FAX) |
100 characters or less |
False |
|
|
|
string (mail address) |
200 characters or less |
False |
|
|
mobile_tel |
string (cell phone number) |
100 characters or less |
False |
|
|
mobile_email |
string (Mobile e-mail address) |
100 characters or less |
False |
|
|
zip |
string (Postal code) |
50 characters or less |
False |
|
|
pref_id |
integer (State ID) |
Only the state code that is registered |
False |
|
|
address |
string (Street address) |
255 characters or less |
False |
|
|
url |
string (URL) |
255 characters or less |
False |
|
|
latitude |
integer (latitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
longitude |
integer (longitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
lead_source_kbn_id |
integer (Lead Source) |
Only lead source ID that is registered |
False |
|
|
lead_source |
string (Lead source details) |
3000 characters or less |
False |
|
|
status |
integer (status) |
1: Active 2: Inactive |
True |
|
|
open_status |
integer (Public status) |
1: Published in the entire 3: Private (his only) |
True |
|
|
owner_user_id |
integer (Business card owner user ID) |
Only the ID of the user who has been registered |
False |
|
|
owner_user |
string (Business card owner's name) |
255 characters or less |
False |
|
|
trade_on |
string (Business card exchange Date) |
yyyy / mm / dd |
False |
|
|
note |
string (Memo) |
3000 characters or less |
False |
|
|
direct_note |
string (Handwritten notes) |
3000 characters or less |
False |
Returns:
Type:Action_create_business_cardResponse
Summary: Get business cards
Description: Get business cards registered in HotProfile
Syntax:
HotProfile.Action_get_business_cards ([advanced][Optional]integer page[number], [advanced][Optional]integer page[display_number], [advanced][Optional]boolean page[date_format_option], [advanced][Optional]string order[key], [advanced][Optional]string order[type], [Optional]string search[family_name], [Optional]string search[first_name], [advanced][Optional]string search[family_name_kana], [advanced][Optional]string search[first_name_kana], [Optional]string search[client_name], [Optional]string search[from_trade_on], [Optional]string search[to_trade_on], [advanced][Optional]string search[from_updated_on], [advanced][Optional]string search[to_updated_on], [advanced][Optional]string search[from_created_on], [advanced][Optional]string search[to_created_on], [advanced][Optional]string search[organization_ancestry_all_name], [advanced][Optional]string search[post], [advanced][Optional]string search[tel], [advanced][Optional]string search[fax], [advanced][Optional]string search[mobile_tel], [advanced][Optional]string search[email], [advanced][Optional]string search[mobile_email], [advanced][Optional]integer search[role_id], [advanced][Optional]string search[zip], [advanced][Optional]string search[address], [advanced][Optional]string search[url], [advanced][Optional]string search[note], [advanced][Optional]string search[direct_note], [advanced][Optional]string search[lead_source], [advanced][Optional]string search[request_key], [advanced][Optional]integer search[latitude], [advanced][Optional]integer search[longitude])
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
page[number] |
integer (page number) |
Single-byte numbers (1 ~) |
False |
|
|
page[display_number] |
integer (Get the number of 1 page) |
Single-byte number (1 to 1000) |
False |
|
|
page[date_format_option] |
boolean (Date item format specified option) |
true or false |
False |
|
|
order[key] |
string (Items to be sorted) |
id, trade_on, updated_at |
False |
|
|
order[type] |
string (Sort direction) |
asc or desc |
False |
|
|
search[family_name] |
string (Name (last name)) |
Partial Match |
False |
|
|
search[first_name] |
string (Full name (first name)) |
Partial Match |
False |
|
|
search[family_name_kana] |
string (Last name (Kana)) |
Partial Match |
False |
|
|
search[first_name_kana] |
string (Name (Kana)) |
Partial Match |
False |
|
|
search[client_name] |
string (client name) |
Partial Match |
False |
|
|
search[from_trade_on] |
string (Business card exchange date (from search)) |
yyyy / mm / dd |
False |
|
|
search[to_trade_on] |
string (Business card exchange date (to search)) |
yyyy / mm / dd |
False |
|
|
search[from_updated_on] |
string (Date (from search)) |
yyyy / mm / dd |
False |
|
|
search[to_updated_on] |
string (Update date (to search)) |
yyyy / mm / dd |
False |
|
|
search[from_created_on] |
string (Input date (from search)) |
yyyy / mm / dd |
False |
|
|
search[to_created_on] |
string (Input date (to search)) |
yyyy / mm / dd |
False |
|
|
search[organization_ancestry_all_name] |
string (Department) |
Partial Match |
False |
|
|
search[post] |
string (Position) |
Partial Match |
False |
|
|
search[tel] |
string (phone number) |
Partial Match |
False |
|
|
search[fax] |
string (FAX) |
Partial Match |
False |
|
|
search[mobile_tel] |
string (cell phone number) |
Partial Match |
False |
|
|
search[email] |
string (mail address) |
Partial Match |
False |
|
|
search[mobile_email] |
string (Mobile e-mail address) |
Partial Match |
False |
|
|
search[role_id] |
integer (group) |
Authority group ID |
False |
|
|
search[zip] |
string (Postal code) |
Partial Match |
False |
|
|
search[address] |
string (Street address) |
Partial Match |
False |
|
|
search[url] |
string (URL) |
Partial Match |
False |
|
|
search[note] |
string (Memo) |
Partial Match |
False |
|
|
search[direct_note] |
string (Handwritten notes) |
Partial Match |
False |
|
|
search[lead_source] |
string (Lead source details) |
Partial Match |
False |
|
|
search[request_key] |
string (Inquiry number) |
Partial Match |
False |
|
|
search[latitude] |
integer (latitude) |
Partial Match |
False |
|
|
search[longitude] |
integer (longitude) |
Partial Match |
False |
Returns:
Type:Action_get_business_cardsResponse
Summary: Update a business card
Description: Update a business card in HotProfile
Syntax:
HotProfile.Action_update_business_card (integer id, integer client_id, [Optional]integer organization_id, [Optional]string family_name, [Optional]string first_name, [Optional]string family_name_kana, [Optional]string first_name_kana, [Optional]string tel, [Optional]integer extension, [Optional]string fax, [Optional]string email, [Optional]string mobile_tel, [Optional]string mobile_email, [Optional]string zip, [Optional]integer pref_id, [Optional]string address, [Optional]string url, [advanced][Optional]integer latitude, [advanced][Optional]integer longitude, [advanced][Optional]integer lead_source_kbn_id, [advanced][Optional]string lead_source, [Optional]integer status, [Optional]integer open_status, [Optional]integer owner_user_id, [Optional]string owner_user, [Optional]string trade_on, [Optional]string note, [advanced][Optional]string direct_note)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer (Business card ID) |
Only the ID of the business cards that are registered |
True |
|
|
client_id |
integer (Client ID) |
Only the ID of the client that is registered |
True |
|
|
organization_id |
integer (Department ID) |
Only the ID of the department that are registered |
False |
|
|
family_name |
string (Surname) |
100 characters or less |
False |
|
|
first_name |
string (Name) |
100 characters or less |
False |
|
|
family_name_kana |
string (Last name (Kana)) |
100 characters or less |
False |
|
|
first_name_kana |
string (Name (Kana)) |
100 characters or less |
False |
|
|
tel |
string (phone number) |
100 characters or less |
False |
|
|
extension |
integer (Extension number) |
Integer only up to 8 characters |
False |
|
|
fax |
string (FAX) |
100 characters or less |
False |
|
|
|
string (mail address) |
200 characters or less |
False |
|
|
mobile_tel |
string (cell phone number) |
100 characters or less |
False |
|
|
mobile_email |
string (Mobile e-mail address) |
100 characters or less |
False |
|
|
zip |
string (Postal code) |
50 characters or less |
False |
|
|
pref_id |
integer (State ID) |
Only the state code that is registered |
False |
|
|
address |
string (Street address) |
255 characters or less |
False |
|
|
url |
string (URL) |
255 characters or less |
False |
|
|
latitude |
integer (latitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
longitude |
integer (longitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
lead_source_kbn_id |
integer (Lead Source) |
Only lead source ID that is registered |
False |
|
|
lead_source |
string (Lead source details) |
3000 characters or less |
False |
|
|
status |
integer (status) |
1: Active 2: Inactive |
False |
|
|
open_status |
integer (Public status) |
1: Published in the entire 3: Private (his only) |
False |
|
|
owner_user_id |
integer (Business card owner user ID) |
Only the ID of the user who has been registered |
False |
|
|
owner_user |
string (Other business card owner) |
255 characters or less |
False |
|
|
trade_on |
string (Business card exchange Date) |
yyyy / mm / dd |
False |
|
|
note |
string (Memo) |
3000 characters or less |
False |
|
|
direct_note |
string (Handwritten notes) |
3000 characters or less |
False |
Returns:
Type:Action_update_business_cardResponse
Summary: Register a client
Description: Register a client to HotProfile
Syntax:
HotProfile.Action_create_client (string name, [Optional]string name_kana, string name_disp, [Optional]string zip, [Optional]integer pref_id, [Optional]string address, [Optional]integer latitude, [Optional]integer longitude, [Optional]integer business_category_kbn, [Optional]integer worker_number_kbn, [Optional]integer capital_kbn, [Optional]integer ipo_kbn, [Optional]string sales_last_year, [Optional]string main_tel, [Optional]string url, [Optional]string mail_domain, [Optional]integer user_id, [Optional]string note, [advanced][Optional]string name_sub, [advanced][Optional]string name_kana_sub, [advanced][Optional]string zip_sub, [advanced][Optional]string address_sub, [advanced][Optional]string pref_sub)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
name |
string (client name) |
255 characters or less |
True |
|
|
name_kana |
string (Client Name Kana) |
255 characters or less |
False |
|
|
name_disp |
string (Client name abbreviation) |
255 characters or less |
True |
|
|
zip |
string (Postal code) |
100 characters or less |
False |
|
|
pref_id |
integer (Prefectures) |
Only the state code that is registered |
False |
|
|
address |
string (Street address) |
255 characters or less |
False |
|
|
latitude |
integer (latitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
longitude |
integer (longitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
business_category_kbn |
integer (Type of industry) |
Only industry segment ID that is registered |
False |
|
|
worker_number_kbn |
integer (number of employees) |
Only the classification ID number of employees that are registered |
False |
|
|
capital_kbn |
integer (Capital stock) |
Only capital classification ID that is registered |
False |
|
|
ipo_kbn |
integer (Listed division) |
Only listed classification ID that is registered |
False |
|
|
sales_last_year |
string (Last year sales) |
255 characters or less |
False |
|
|
main_tel |
string (Representative phone number) |
255 characters or less |
False |
|
|
url |
string (URL) |
255 characters or less |
False |
|
|
mail_domain |
string (E-mail domain) |
255 characters or less |
False |
|
|
user_id |
integer (Salesperson user ID) |
Only the ID of the user who has been registered |
False |
|
|
note |
string (Memo) |
3000 characters or less |
False |
|
|
name_sub |
string (Client Name (second language)) |
255 characters or less |
False |
|
|
name_kana_sub |
string (Client Name Kana (second language)) |
255 characters or less |
False |
|
|
zip_sub |
string (Postal code (second language)) |
100 characters or less |
False |
|
|
address_sub |
string (Address (second language)) |
255 characters or less |
False |
|
|
pref_sub |
string (State (second language)) |
255 characters or less |
False |
Returns:
Type:Action_create_clientResponse
Summary: Get clients
Description: Get clients registered in HotProfile
Syntax:
HotProfile.Action_get_clients ([advanced][Optional]integer page[number], [advanced][Optional]integer page[display_number], [advanced][Optional]integer page[date_format_option], [advanced][Optional]string order[key], [advanced][Optional]string order[type], [advanced][Optional]integer search[from_id], [advanced][Optional]integer search[to_id], [Optional]string search[name], [advanced][Optional]string search[name_kana], [Optional]string search[name_disp], [advanced][Optional]string search[zip], [advanced][Optional]string search[address], [advanced][Optional]string search[latitude], [advanced][Optional]string search[longitude], [advanced][Optional]string search[corporate_number], [advanced][Optional]string search[main_tel], [advanced][Optional]string search[url], [advanced][Optional]string search[mail_domain], [advanced][Optional]string search[note], [Optional]integer search[user_ids], [advanced][Optional]string search[name_sub], [advanced][Optional]string search[name_kana_sub], [advanced][Optional]string search[zip_sub], [advanced][Optional]string search[address_sub], [advanced][Optional]string search[pref_sub], [advanced][Optional]string search[from_created_on], [advanced][Optional]string search[to_created_on], [advanced][Optional]string search[from_updated_on], [advanced][Optional]string search[to_updated_on], [advanced][Optional]string search[from_datetime_updated_on], [advanced][Optional]string search[to_datetime_updated_on])
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
page[number] |
integer (page number) |
Single-byte numbers (1 ~) |
False |
|
|
page[display_number] |
integer (Get the number of 1 page) |
Single-byte number (1 to 1000) |
False |
|
|
page[date_format_option] |
integer (Date item format specified option) |
0:off or 1:on |
False |
|
|
order[key] |
string (Items to be sorted) |
Over |
False |
|
|
order[type] |
string (Sort direction) |
asc or desc |
False |
|
|
search[from_id] |
integer (Client ID (from search)) |
id> = from_idfrom only be specified. |
False |
|
|
search[to_id] |
integer (Client ID (to search)) |
id <= to_idto only be specified. |
False |
|
|
search[name] |
string (client name) |
Partial Match |
False |
|
|
search[name_kana] |
string (Client Name Kana) |
Partial Match |
False |
|
|
search[name_disp] |
string (abbreviation) |
Partial Match |
False |
|
|
search[zip] |
string (Postal code) |
Partial Match |
False |
|
|
search[address] |
string (Street address) |
Partial Match |
False |
|
|
search[latitude] |
string (latitude) |
Partial Match |
False |
|
|
search[longitude] |
string (longitude) |
Partial Match |
False |
|
|
search[corporate_number] |
string (Employer Identification Number) |
Partial Match |
False |
|
|
search[main_tel] |
string (Representative phone number) |
Partial Match |
False |
|
|
search[url] |
string (URL) |
Partial Match |
False |
|
|
search[mail_domain] |
string (E-mail domain) |
Partial Match |
False |
|
|
search[note] |
string (Memo) |
Partial Match |
False |
|
|
search[user_ids] |
integer (Sales representative) |
Only the ID of the user who has been registered |
False |
|
|
search[name_sub] |
string (Client Name (second language)) |
If the second language feature is enabled only |
False |
|
|
search[name_kana_sub] |
string (Client Name Kana (second language)) |
If the second language feature is enabled only |
False |
|
|
search[zip_sub] |
string (Postal code (second language)) |
If the second language feature is enabled only |
False |
|
|
search[address_sub] |
string (Address (second language)) |
If the second language feature is enabled only |
False |
|
|
search[pref_sub] |
string (State (second language)) |
If the second language feature is enabled only |
False |
|
|
search[from_created_on] |
string (Input date (from search)) |
yyyy / mm / dd |
False |
|
|
search[to_created_on] |
string (Input date (to search)) |
yyyy / mm / dd |
False |
|
|
search[from_updated_on] |
string (Date (from search)) |
yyyy / mm / dd |
False |
|
|
search[to_updated_on] |
string (Update date (to search)) |
yyyy / mm / dd |
False |
|
|
search[from_datetime_updated_on] |
string (Update date and time (from search)) |
yyyy / mm / dd HH: mm: ss |
False |
|
|
search[to_datetime_updated_on] |
string (Update date and time (to search)) |
yyyy / mm / dd HH: mm: ss |
False |
Returns:
Type:Action_get_clientsResponse
Summary: Update a client
Description: Update a client in HotProfile
Syntax:
HotProfile.Action_update_client (integer id, [Optional]string name, [Optional]string name_kana, [Optional]string name_disp, [Optional]string zip, [Optional]integer pref_id, [Optional]string address, [Optional]integer latitude, [Optional]integer longitude, [Optional]integer business_category_kbn, [Optional]integer worker_number_kbn, [Optional]integer capital_kbn, [Optional]integer ipo_kbn, [Optional]string sales_last_year, [Optional]string main_tel, [Optional]string url, [Optional]string mail_domain, [Optional]integer user_id, [Optional]string note, [advanced][Optional]string name_sub, [advanced][Optional]string name_kana_sub, [advanced][Optional]string zip_sub, [advanced][Optional]string address_sub, [advanced][Optional]string pref_sub)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer (Client ID) |
Only the ID of the client that is registered |
True |
|
|
name |
string (client name) |
255 characters or less |
False |
|
|
name_kana |
string (Client Name Kana) |
255 characters or less |
False |
|
|
name_disp |
string (Client name abbreviation) |
255 characters or less |
False |
|
|
zip |
string (Postal code) |
100 characters or less |
False |
|
|
pref_id |
integer (Prefectures) |
Only the state code that is registered |
False |
|
|
address |
string (Street address) |
255 characters or less |
False |
|
|
latitude |
integer (latitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
longitude |
integer (longitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
business_category_kbn |
integer (Type of industry) |
Only industry segment ID that is registered |
False |
|
|
worker_number_kbn |
integer (number of employees) |
Only the classification ID number of employees that are registered |
False |
|
|
capital_kbn |
integer (Capital stock) |
Only capital classification ID that is registered |
False |
|
|
ipo_kbn |
integer (Listed division) |
Only listed classification ID that is registered |
False |
|
|
sales_last_year |
string (Last year sales) |
255 characters or less |
False |
|
|
main_tel |
string (Representative phone number) |
255 characters or less |
False |
|
|
url |
string (URL) |
255 characters or less |
False |
|
|
mail_domain |
string (E-mail domain) |
255 characters or less |
False |
|
|
user_id |
integer (Salesperson user ID) |
Only the ID of the user who has been registered |
False |
|
|
note |
string (Memo) |
3000 characters or less |
False |
|
|
name_sub |
string (Client Name (second language)) |
255 characters or less |
False |
|
|
name_kana_sub |
string (Client Name Kana (second language)) |
255 characters or less |
False |
|
|
zip_sub |
string (Postal code (second language)) |
100 characters or less |
False |
|
|
address_sub |
string (Address (second language)) |
255 characters or less |
False |
|
|
pref_sub |
string (State (second language)) |
255 characters or less |
False |
Returns:
Type:Action_update_clientResponse
Summary: Register a lead
Description: Register a lead to HotProfile
Syntax:
HotProfile.Action_create_lead (integer client_id, string family_name, [Optional]string first_name, [Optional]string family_name_kana, [Optional]string first_name_kana, [Optional]integer organization_id, [Optional]string post, [Optional]string tel, [Optional]integer extension, [Optional]string fax, [Optional]string email, [Optional]string mobile_tel, [Optional]string mobile_email, [Optional]string zip, [Optional]integer pref_id, [Optional]string address, [Optional]string url, [Optional]integer lead_status, [advanced][Optional]integer latitude, [advanced][Optional]integer longitude, [advanced][Optional]integer lead_source_kbn_id, [advanced][Optional]string lead_source, [advanced][Optional]string note, [advanced][Optional]boolean error_mail_flg, [advanced][Optional]boolean error_tel_flg, [advanced][Optional]boolean error_fax_flg, [advanced][Optional]boolean error_address_flg, [advanced][Optional]boolean not_mail_flg, [advanced][Optional]boolean not_tel_flg, [advanced][Optional]boolean not_fax_flg, [advanced][Optional]boolean not_dm_flg, [advanced][Optional]boolean competitor_flg, [advanced][Optional]boolean important_customer_flg, [advanced][Optional]boolean end_user_flg, [advanced][Optional]boolean store_flg, [advanced][Optional]string customer_id, [advanced][Optional]string owner_user_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
client_id |
integer (Client ID) |
Only the ID of the client that is registered |
True |
|
|
family_name |
string (Surname) |
100 characters or less |
True |
|
|
first_name |
string (Name) |
100 characters or less |
False |
|
|
family_name_kana |
string (Last name (Kana)) |
100 characters or less |
False |
|
|
first_name_kana |
string (Name (Kana)) |
100 characters or less |
False |
|
|
organization_id |
integer (Department ID) |
Only the ID of the client that is registered |
False |
|
|
post |
string (Position) |
255 characters or less |
False |
|
|
tel |
string (phone number) |
100 characters or less |
False |
|
|
extension |
integer (Extension number) |
Integer only up to 8 characters |
False |
|
|
fax |
string (FAX) |
100 characters or less |
False |
|
|
|
string (mail address) |
200 characters or less |
False |
|
|
mobile_tel |
string (cell phone number) |
100 characters or less |
False |
|
|
mobile_email |
string (Mobile e-mail address) |
100 characters or less |
False |
|
|
zip |
string (Postal code) |
50 characters or less |
False |
|
|
pref_id |
integer (Prefecture code) |
Only ID that exists in the choice of prefecture |
False |
|
|
address |
string (Street address) |
255 characters or less |
False |
|
|
url |
string (URL) |
255 characters or less |
False |
|
|
lead_status |
integer (Read status) |
Only ID that exists in the choice of read status |
False |
|
|
latitude |
integer (latitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
longitude |
integer (longitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
lead_source_kbn_id |
integer (Lead Source ID) |
Lead Management - lead source of the choices management only ID that is registered in the |
False |
|
|
lead_source |
string (Lead source details) |
3000 characters or less |
False |
|
|
note |
string (Memo) |
3000 characters or less |
False |
|
|
error_mail_flg |
boolean (E-mail error) |
flag |
False |
|
|
error_tel_flg |
boolean (Phone number error) |
flag |
False |
|
|
error_fax_flg |
boolean (FAX number error) |
flag |
False |
|
|
error_address_flg |
boolean (Address error) |
flag |
False |
|
|
not_mail_flg |
boolean (E-mail rejection) |
flag |
False |
|
|
not_tel_flg |
boolean (The call rejection) |
flag |
False |
|
|
not_fax_flg |
boolean (FAX delivery refusal) |
flag |
False |
|
|
not_dm_flg |
boolean (DM delivery refusal) |
flag |
False |
|
|
competitor_flg |
boolean (Competitors) |
flag |
False |
|
|
important_customer_flg |
boolean (Important customer) |
flag |
False |
|
|
end_user_flg |
boolean (End-user) |
flag |
False |
|
|
store_flg |
boolean (Sales outlet) |
flag |
False |
|
|
customer_id |
string (Customer ID) |
255 characters or less |
False |
|
|
owner_user_id |
string (Salesperson user ID) |
Only the ID of the user who is registered |
False |
Returns:
Type:Action_create_leadResponse
Summary: Get leads
Description: Get leads registered in HotProfile
Syntax:
HotProfile.Action_get_leads ([Optional]string search[family_name], [Optional]string search[first_name], [Optional]string search[client_name], [advanced][Optional]integer search[from_id], [advanced][Optional]integer search[to_id], [advanced][Optional]string order[key], [advanced][Optional]string order[type], [advanced][Optional]integer page[display_number], [advanced][Optional]integer page[number], [advanced][Optional]integer page[date_format_option], [advanced][Optional]integer search[client_id], [advanced][Optional]string search[client][name_kana], [advanced][Optional]string search[client][name_disp], [Optional]integer search[owner_user_id], [advanced][Optional]integer search[role_id], [advanced][Optional]integer search[organization_id], [advanced][Optional]string search[organization_name], [advanced][Optional]string search[organization_ancestry_all_name], [advanced][Optional]string search[post], [advanced][Optional]string search[family_name_kana], [advanced][Optional]string search[first_name_kana], [Optional]string search[email], [advanced][Optional]string search[mobile_email], [advanced][Optional]string search[tel], [advanced][Optional]string search[extension], [advanced][Optional]string search[fax], [advanced][Optional]string search[mobile_tel], [advanced][Optional]string search[zip], [advanced][Optional]string search[pref], [advanced][Optional]string search[address], [advanced][Optional]string search[url], [advanced][Optional]string search[from_created_on], [advanced][Optional]string search[to_created_on], [advanced][Optional]string search[from_updated_on], [advanced][Optional]string search[to_updated_on], [advanced][Optional]string search[from_datetime_updated_on], [advanced][Optional]string search[to_datetime_updated_on], [advanced][Optional]string search[from_trade_on], [advanced][Optional]string search[to_trade_on], [advanced][Optional]integer search[from_latitude], [advanced][Optional]integer search[to_latitude], [advanced][Optional]integer search[from_longitude], [advanced][Optional]integer search[to_longitude], [advanced][Optional]string search[latitude], [advanced][Optional]string search[longitude], [advanced][Optional]integer search[lead_status], [advanced][Optional]integer search[lead_source_kbn_ids], [advanced][Optional]string search[lead_source], [advanced][Optional]integer search[important_customer_flg], [advanced][Optional]integer search[end_user_flg], [advanced][Optional]integer search[store_flg], [advanced][Optional]integer search[competitor_flg], [advanced][Optional]integer search[error_mail_flg], [advanced][Optional]integer search[error_tel_flg], [advanced][Optional]integer search[error_fax_flg], [advanced][Optional]integer search[error_address_flg], [advanced][Optional]integer search[not_mail_flg], [advanced][Optional]integer search[not_tel_flg], [advanced][Optional]integer search[not_fax_flg], [advanced][Optional]integer search[not_dm_flg], [advanced][Optional]string search[note], [advanced][Optional]string search[customer_id], [Optional]string search[name], [Optional]string search[ids], [advanced][Optional]string search[user_ids], [advanced][Optional]string search[multiple])
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
search[family_name] |
string (Name (last name)) |
Partial Match |
False |
|
|
search[first_name] |
string (Full name (first name)) |
Partial Match |
False |
|
|
search[client_name] |
string (client name) |
Partial Match |
False |
|
|
search[from_id] |
integer (id search (from ~)) |
Search for data after the specified id |
False |
|
|
search[to_id] |
integer (id search (~ to)) |
Search for data up to the specified id |
False |
|
|
order[key] |
string (Sort key) |
Can be either a (id, create_at, update_at) |
False |
|
|
order[type] |
string (sort) |
Ascending order: asc, descending order: desc |
False |
|
|
page[display_number] |
integer (Acquisition number) |
Up to 100 (Default: 20) |
False |
|
|
page[number] |
integer (page number) |
Single-byte numbers (1 ~) |
False |
|
|
page[date_format_option] |
integer (Date item format specified option) |
0:off or 1:on |
False |
|
|
search[client_id] |
integer (Client ID) |
Partial Match |
False |
|
|
search[client][name_kana] |
string (Client Name Kana) |
Partial Match |
False |
|
|
search[client][name_disp] |
string (Client name abbreviation) |
Partial Match |
False |
|
|
search[owner_user_id] |
integer (Salesperson ID) |
Match |
False |
|
|
search[role_id] |
integer (Rights group) |
Match |
False |
|
|
search[organization_id] |
integer (Department ID) |
Match |
False |
|
|
search[organization_name] |
string (Organization name (bottom layer)) |
Partial Match |
False |
|
|
search[organization_ancestry_all_name] |
string (Organization name (all levels)) |
Partial Match |
False |
|
|
search[post] |
string (Position) |
Partial Match |
False |
|
|
search[family_name_kana] |
string (Last name Kana) |
Partial Match |
False |
|
|
search[first_name_kana] |
string (Name Kana) |
Partial Match |
False |
|
|
search[email] |
string (e-mail address) |
Partial Match |
False |
|
|
search[mobile_email] |
string (Mobile e-mail address) |
Partial Match |
False |
|
|
search[tel] |
string (phone number) |
Partial Match |
False |
|
|
search[extension] |
string (Telephone number (extension number)) |
Partial Match |
False |
|
|
search[fax] |
string (FAX) |
Partial Match |
False |
|
|
search[mobile_tel] |
string (cell phone number) |
Partial Match |
False |
|
|
search[zip] |
string (Postal code) |
Partial Match |
False |
|
|
search[pref] |
string (Prefectures) |
Partial Match |
False |
|
|
search[address] |
string (Street address) |
Partial Match |
False |
|
|
search[url] |
string (URL) |
Partial Match |
False |
|
|
search[from_created_on] |
string (input date) |
Entry Date> = search value example) 2016/03/23 |
False |
|
|
search[to_created_on] |
string (input date) |
Input Date <= search value example) 2016/03/23 |
False |
|
|
search[from_updated_on] |
string (Date of renovation) |
Date> = search value example) 2016/03/23 |
False |
|
|
search[to_updated_on] |
string (Date of renovation) |
Date <= search value example) 2016/03/23 |
False |
|
|
search[from_datetime_updated_on] |
string (Date of renovation) |
Date> = search value example) 2016/03/23 12:05:11 |
False |
|
|
search[to_datetime_updated_on] |
string (Date of renovation) |
Date <= search value example) 2016/03/23 12:05:11 |
False |
|
|
search[from_trade_on] |
string (Information acquisition date) |
Information acquisition date> = search value example) 2016/03/23 |
False |
|
|
search[to_trade_on] |
string (Information acquisition date) |
Information acquisition date <= search value example) 2016/03/23 |
False |
|
|
search[from_latitude] |
integer (latitude) |
Latitude <= search value example) 35.7150244 Search |
False |
|
|
search[to_latitude] |
integer (latitude) |
Latitude <= search value example) 35.7150244 Search |
False |
|
|
search[from_longitude] |
integer (longitude) |
Longitude <= search value example) 139.7079309 |
False |
|
|
search[to_longitude] |
integer (longitude) |
Longitude <= search value example) 139.7079309 |
False |
|
|
search[latitude] |
string (latitude) |
Partial Match |
False |
|
|
search[longitude] |
string (longitude) |
Partial Match |
False |
|
|
search[lead_status] |
integer (Read status) |
1: active, 2: Non-active |
False |
|
|
search[lead_source_kbn_ids] |
integer (Lead Source) |
Lead source classification ID search |
False |
|
|
search[lead_source] |
string (Lead Source (details)) |
Partial Match |
False |
|
|
search[important_customer_flg] |
integer (Important customer) |
1: Check Yes 0: no check |
False |
|
|
search[end_user_flg] |
integer (End-user) |
1: Check Yes 0: no check |
False |
|
|
search[store_flg] |
integer (Sales outlet) |
1: Check Yes 0: no check |
False |
|
|
search[competitor_flg] |
integer (Competitors) |
1: Check Yes 0: no check |
False |
|
|
search[error_mail_flg] |
integer (E-mail error) |
1: Check Yes 0: no check |
False |
|
|
search[error_tel_flg] |
integer (Phone number error) |
1: Check Yes 0: no check |
False |
|
|
search[error_fax_flg] |
integer (FAX number error) |
1: Check Yes 0: no check |
False |
|
|
search[error_address_flg] |
integer (Address error) |
1: Check Yes 0: no check |
False |
|
|
search[not_mail_flg] |
integer (E-mail rejection) |
1: Check Yes 0: no check |
False |
|
|
search[not_tel_flg] |
integer (The call rejection) |
1: Check Yes 0: no check |
False |
|
|
search[not_fax_flg] |
integer (FAX delivery refusal) |
1: Check Yes 0: no check |
False |
|
|
search[not_dm_flg] |
integer (DM delivery refusal) |
1: Check Yes 0: no check |
False |
|
|
search[note] |
string (Memo) |
Partial Match |
False |
|
|
search[customer_id] |
string (Customer ID) |
Partial Match |
False |
|
|
search[name] |
string (Full name) |
Partial Match |
False |
|
|
search[ids] |
string (Lead ID) |
Specified in the comma-delimited. (OR search) |
False |
|
|
search[user_ids] |
string (Business card owner) |
Specified in the comma-delimited. (OR search) |
False |
|
|
search[multiple] |
string (Simple Search) |
You can specify multiple search words separated by spaces. |
False |
Returns:
Summary: Update a lead
Description: Update a lead in HotProfile
Syntax:
HotProfile.Action_update_lead (integer id, integer client_id, [Optional]integer organization_id, [Optional]string post, [Optional]string family_name, [Optional]string first_name, [Optional]string family_name_kana, [Optional]string first_name_kana, [Optional]string tel, [Optional]integer extension, [Optional]string fax, [Optional]string email, [Optional]string mobile_tel, [Optional]string mobile_email, [Optional]string zip, [Optional]integer pref_id, [Optional]string address, [Optional]string url, [Optional]integer lead_status, [advanced][Optional]integer latitude, [advanced][Optional]integer longitude, [advanced][Optional]integer lead_source_kbn_id, [advanced][Optional]string lead_source, [advanced][Optional]string note, [advanced][Optional]boolean error_mail_flg, [advanced][Optional]boolean error_tel_flg, [advanced][Optional]boolean error_fax_flg, [advanced][Optional]boolean error_address_flg, [advanced][Optional]boolean not_mail_flg, [advanced][Optional]boolean not_tel_flg, [advanced][Optional]boolean not_fax_flg, [advanced][Optional]boolean not_dm_flg, [advanced][Optional]boolean competitor_flg, [advanced][Optional]boolean important_customer_flg, [advanced][Optional]boolean end_user_flg, [advanced][Optional]boolean store_flg, [advanced][Optional]string customer_id, [advanced][Optional]string owner_user_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer (Lead ID) |
Only the ID of the lead that has been registered |
True |
|
|
client_id |
integer (Client ID) |
Only the ID of the client that is registered |
True |
|
|
organization_id |
integer (Department ID) |
Only the ID of the client that is registered |
False |
|
|
post |
string (Position) |
255 characters or less |
False |
|
|
family_name |
string (Surname) |
100 characters or less |
False |
|
|
first_name |
string (Name) |
100 characters or less |
False |
|
|
family_name_kana |
string (Last name (Kana)) |
100 characters or less |
False |
|
|
first_name_kana |
string (Name (Kana)) |
100 characters or less |
False |
|
|
tel |
string (phone number) |
100 characters or less |
False |
|
|
extension |
integer (Extension number) |
Integer only?8 characters or less |
False |
|
|
fax |
string (FAX) |
100 characters or less |
False |
|
|
|
string (mail address) |
200 characters or less |
False |
|
|
mobile_tel |
string (cell phone number) |
100 characters or less |
False |
|
|
mobile_email |
string (Mobile e-mail address) |
100 characters or less |
False |
|
|
zip |
string (Postal code) |
50 characters or less |
False |
|
|
pref_id |
integer (Prefecture code) |
Only ID that exists in the choice of prefecture |
False |
|
|
address |
string (Street address) |
255 characters or less |
False |
|
|
url |
string (URL) |
255 characters or less |
False |
|
|
lead_status |
integer (Read status) |
Only ID that exists in the choice of read status |
False |
|
|
latitude |
integer (latitude) |
??? If there is a tag tag 1, rather than the name of the tag itself, specify the ID |
False |
|
|
longitude |
integer (longitude) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
lead_source_kbn_id |
integer (Lead Source ID) |
Integer 3 digits, within decimal 14 digits |
False |
|
|
lead_source |
string (Lead source details) |
Lead Management - lead source of the choices management only ID that is registered in the |
False |
|
|
note |
string (Memo) |
3000 characters or less |
False |
|
|
error_mail_flg |
boolean (E-mail error) |
Option management - ID that is registered in the Lead Management interested in products only |
False |
|
|
error_tel_flg |
boolean (Phone number error) |
flag |
False |
|
|
error_fax_flg |
boolean (FAX number error) |
flag |
False |
|
|
error_address_flg |
boolean (Address error) |
flag |
False |
|
|
not_mail_flg |
boolean (E-mail rejection) |
flag |
False |
|
|
not_tel_flg |
boolean (The call rejection) |
flag |
False |
|
|
not_fax_flg |
boolean (FAX delivery refusal) |
flag |
False |
|
|
not_dm_flg |
boolean (DM delivery refusal) |
flag |
False |
|
|
competitor_flg |
boolean (Competitors) |
flag |
False |
|
|
important_customer_flg |
boolean (Important customer) |
flag |
False |
|
|
end_user_flg |
boolean (End-user) |
flag |
False |
|
|
store_flg |
boolean (Sales outlet) |
flag |
False |
|
|
customer_id |
string (Customer ID) |
flag |
False |
|
|
owner_user_id |
string (Salesperson user ID) |
255 characters or less |
False |
Returns:
Type:Action_update_leadResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
business_cards |
array of (Business_cardsItem)
|
business_cards |
|
pages |
|
pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string
|
Street address |
|
address1 |
string
|
Street address1 |
|
address2 |
string
|
Street address2 |
|
address3 |
string
|
Street address3 |
|
client_name |
string
|
client name |
|
created_at |
string
|
input date |
|
direct_note |
string
|
Handwritten notes |
|
|
string
|
mail address |
|
fax |
string
|
FAX |
|
id |
integer(int32)
|
Business card ID |
|
latitude |
string
|
latitude |
|
lead_source |
string
|
Lead source details |
|
lead_source_kbn_id |
integer(int32)
|
Lead Source |
|
longitude |
string
|
longitude |
|
mobile_email |
string
|
Mobile e-mail address |
|
mobile_tel |
string
|
cell phone number |
|
name |
string
|
Full name |
|
name_kana |
string
|
Name (Kana) |
|
note |
string
|
Memo |
|
organization_name |
string
|
Department |
|
post |
string
|
Position |
|
pref_id |
integer(int32)
|
Prefectures |
|
request_key |
string
|
Inquiry number |
|
status |
integer(int32)
|
status |
|
tag_ids |
array of (integer(int32))
|
tag |
|
tel |
string
|
phone number |
|
trade_on |
string
|
Business card exchange Date |
|
updated_at |
string
|
Date of renovation |
|
url |
string
|
URL |
|
user_name |
string
|
Business card owner |
|
zip |
string
|
Postal code |
Summary:
Description: pages
Properties:
|
Name |
Type |
Summary |
|
current_number |
integer(int32)
|
The number of the current page |
|
display_number |
integer(int32)
|
Number of acquisition of 1 page |
|
total_count |
integer(int32)
|
Of the number of search results |
|
total_number |
integer(int32)
|
Total number of pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
clients |
array of (ClientsItem)
|
clients |
|
pages |
|
pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Company ID |
|
name |
string
|
company name |
|
name_kana |
string
|
Company Name Kana |
|
name_disp |
string
|
Company name abbreviation |
|
zip |
string
|
Postal code |
|
pref |
string
|
Prefectures |
|
address |
string
|
Street address |
|
address1 |
string
|
Street address1 |
|
address2 |
string
|
Street address2 |
|
address3 |
string
|
Street address3 |
|
latitude |
string
|
latitude |
|
longitude |
string
|
longitude |
|
business_category_kbn |
string
|
Type of industry |
|
worker_number_kbn |
string
|
number of employees |
|
capital_kbn |
string
|
Capital stock |
|
ipo_kbn |
string
|
Listed division |
|
sales_last_year |
string
|
Last year sales |
|
main_tel |
string
|
Representative phone number |
|
url |
string
|
URL |
|
mail_domain |
string
|
E-mail domain |
|
note |
string
|
Memo |
|
user_name |
string
|
Sales representative |
|
user_code |
string
|
Salesperson ID |
|
corporate_number |
integer(int32)
|
Employer Identification Number |
|
created_at |
string
|
input date |
|
updated_at |
string
|
Date of renovation |
|
items |
array of (string)
|
Custom item list |
|
itemslabel |
string
|
Custom item label |
|
itemsvalue |
string
|
The value of the custom items |
|
total_count |
integer(int32)
|
Of the number of search results |
|
total_number |
integer(int32)
|
Total number of pages |
|
current_number |
integer(int32)
|
The number of the current page |
|
display_number |
integer(int32)
|
Number of acquisition of 1 page |
Summary:
Description: pages
Properties:
|
Name |
Type |
Summary |
|
current_number |
integer(int32)
|
The number of the current page |
|
display_number |
integer(int32)
|
Number of acquisition of 1 page |
|
total_count |
integer(int32)
|
Of the number of search results |
|
total_number |
integer(int32)
|
Total number of pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
leads |
array of (LeadsItem)
|
leads |
|
pages |
|
pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string
|
Street address |
|
address1 |
string
|
Street address1 |
|
address2 |
string
|
Street address2 |
|
address3 |
string
|
Street address3 |
|
client_id |
integer(int32)
|
Client ID |
|
client_name |
string
|
client name |
|
competitor_flg |
string
|
Competitors |
|
created_at |
string
|
input date |
|
current_number |
integer(int32)
|
The number of the current page |
|
customer_id |
string
|
Customer ID |
|
display_number |
integer(int32)
|
Number of acquisition of 1 page |
|
|
string
|
mail address |
|
end_user_flg |
string
|
End-user |
|
error_address_flg |
string
|
Address error |
|
error_fax_flg |
string
|
FAX number error |
|
error_mail_flg |
string
|
E-mail error |
|
error_tel_flg |
string
|
Phone number error |
|
extension |
string
|
Telephone number (extension number) |
|
family_name |
string
|
Name (Last name) |
|
family_name_kana |
string
|
Last name (Kana) |
|
fax |
string
|
FAX |
|
first_name |
string
|
Full name (first name) |
|
first_name_kana |
string
|
Name (Kana) |
|
id |
integer(int32)
|
Lead ID |
|
important_customer_flg |
string
|
Important customer |
|
interest_product_type_ids |
array of (integer(int32))
|
Interested Products List |
|
interest_product_type_names |
array of (string)
|
Interest Product Name List |
|
items |
array of (string)
|
Custom item list |
|
itemslabel |
string
|
Custom item label |
|
itemsvalue |
string
|
The value of the custom items |
|
latitude |
string
|
latitude |
|
lead_source |
string
|
Lead Source (details) |
|
lead_source_kbn_id |
integer(int32)
|
Lead Source ID |
|
lead_source_kbn_name |
string
|
Lead Source |
|
lead_status |
integer(int32)
|
Read status |
|
lead_status_name |
string
|
Read status |
|
longitude |
string
|
longitude |
|
mobile_email |
string
|
Mobile e-mail address |
|
mobile_tel |
string
|
cell phone number |
|
name |
string
|
Full name |
|
name_kana |
string
|
Name Phonetic |
|
not_dm_flg |
string
|
DM delivery refusal |
|
not_fax_flg |
string
|
FAX delivery refusal |
|
not_mail_flg |
string
|
E-mail rejection |
|
not_tel_flg |
string
|
The call rejection |
|
note |
string
|
Memo |
|
organization_hierarchy |
array of (string)
|
Department hierarchy |
|
organization_id |
integer(int32)
|
Organization ID |
|
organization_name |
string
|
Department |
|
owner_user_code |
string
|
User ID of the salesperson |
|
owner_user_id |
integer(int32)
|
User management ID of the salesperson |
|
owner_user_name |
string
|
Sales representative |
|
post |
string
|
Position |
|
pref |
string
|
Prefectures |
|
pref_id |
integer(int32)
|
State ID |
|
store_flg |
string
|
Sales outlet |
|
tag_ids |
array of (integer(int32))
|
Tag ID List |
|
tags |
array of (string)
|
Tag List |
|
tel |
string
|
phone number |
|
total_count |
integer(int32)
|
Of the number of search results |
|
total_number |
integer(int32)
|
Total number of pages |
|
trade_on |
string
|
Information acquisition date |
|
updated_at |
string
|
Date of renovation |
|
url |
string
|
URL |
|
user_names |
array of (string)
|
Business card owner List |
|
zip |
string
|
Postal code |
Summary:
Description: pages
Properties:
|
Name |
Type |
Summary |
|
current_number |
integer(int32)
|
The number of the current page |
|
display_number |
integer(int32)
|
Number of acquisition of 1 page |
|
total_count |
integer(int32)
|
Of the number of search results |
|
total_number |
integer(int32)
|
Total number of pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |