Documentation
LogIn- Getting started
-
CRM API
- Adding/Updating Contacts
- List Filter/Search Contacts
- Contact Timeline Actions
- Contact Info
- Contact Actions
- Adding/Updating Company
- List Filter/Search Companies
- Company Timeline Actions
- Company Info
- Update Company Info
- Add Company Timeline Action
- Adding/Updating Deals
- List Filter/Search Deals
- List Filter/Search Deals Board View
- Drag/Drop Deals between Stages
- Deal WIN/LOSS Reasons
- Owners
- Countries
- Stages
- Funnels
- Lead Scores
- Deal Timeline Actions
- Deal Info
- Update Deal Info
- Add Deal Timeline Action
- List Filter/Search Activities/Tasks
- Add/Update Activity/Tasks
- Contact Messages
- List User Messages
- Delete Actions
-
Phone API
- Send SMS
- Search Phone Numbers
- Order Phone Number
- List Active Phone Numbers
- Disconnect Phone Number
- List Available Audio Files
- Block Phone Number
- Unblock Phone Number
- Check Number Block Status
- List Phone Sub Accounts
- Add/Edit Sub Account
- Attach Phone Number to Sub Account
- List Phone Numbers Per Sub Account
- System API
- Service/Tickets API
- API - Premium Edition
- Callbacks
- Resellers API
- Enabler API
- SMS Error Codes
This API is used to Add ability to register note, call , meeting , task and assign owner .
Method: Get/Post
Base URL : https://hubbucs.com/site/api/hubb/contact_actions
Method: Get/Post
Base URL : https://hubbucs.com/site/api/hubb/contact_actions
Mandatory Parameters | Sample | Description |
---|---|---|
key | 374593457034859 | The company account API key, you can get from company settings > API settings |
action | action |
|
Optional Parameters | Sample | Description |
---|---|---|
contact_id | 789 | ID for the existing contact (this can be replaced with the contact_external_id if it is sent). |
contact_name | Mike Douglas | the name of the contact to associate with, if the contact name doesn't exist and the contact_id not sent, a new contact record will be created, if the contact_id parameter sent, this parameter will be ignored |
contact_email | Mike@gmail.com | the Email of the contact to associate with, if the contact Email doesn't exist and the contact_id not sent, a new contact record will be created, if the contact_id parameter sent, this parameter will be used to update the contact email info |
send_email_to_contact | 1 OR 2 (default value: 2) | if 1: will send email to the associated contact including the deal name and deal ID for reference if 2: will NOT send email to the contact (default value) |
send_email_to_contact_subject | String/Text | Subject of the email to be sent to the associated contact, if empty default subject will be used (New Deal Creation Notification from COMPANY_NAME) |
contact_phone | 54065486544 | the Phone number of the contact to associate with, if the contact Phone number doesn't exist and the contact_id not sent, a new contact record will be created, if the contact_id parameter sent, this parameter will be used to update the contact Phone number info |
match_with_email | Possible Values (1 OR 2) | 1: Yes match with contact email (default value), 2 No: dont match with contact email |
match_with_phone | Possible Values (1 OR 2) | 1: Yes match with contact phone , 2 No: dont match with contact phone (default value) |
check_name | Possible Values (1 OR 2) | if set to 1 : Name will be used to search existing contacts as a unique identifier, if set to 2 or not sent(default value): Name will not be used to check existing contacts as a unique identifier |
contact_source | campaign1 | A Friendly name, you can add to know the source of contact, if not exists in the settings, it will be added automatically |
contact_facebook | facebook ULR or Facebook name |
The Facebook page or name for the contact |
contact_twitter | twitter ULR or twitter name |
The twitter account for the contact |
contact_skype | skype username | The skype username account for the contact |
contact_linkedin | Linkedin username | The Linkedin username account for the contact |
contact_pinterest | pinterest username | The pinterest account for the contact |
contact_googlePlus | googlePlus username | The googlePlus account for the contact |
contact_instagram | instagram username | The instagram account for the contact |
user_token | Fjgnu28nfuskfjj | Token of the user making this action for authentication (it can be replacing email and password). |
newcontact@url.com | email for user to authenticate (this can be replace by user_token) | |
password | 123456 | Password for user to authenticate (this can be replace by user_token) |
contact_external_id | 45655 | the external contact id, if exists, the data below will be used to update the contact info (if sent with contact_id) contact_id has a higher priority . |
For Calls :
Optional Parameters | Sample | Description |
---|---|---|
call_type | 1 or 2 |
|
call_date | 2020-06-07 | in the format YYYY-mm-dd |
call_time | 04:06 | in the format HH:MM in 24hrs format |
call_outcome | string | if no matching value exists, a new outcome will be added to the custom call outcome under customization section |
call_duration | 01:02:05 | call duration in format HH:MM:SS or MM:SS |
from_number | 565846899 | From Phone number/Caller Phone number |
to_number | 548655656 | to Phone number/Called Phone number |
comments | string | |
recording_file | file_uploaded | Only accepted formats: wav, mp3, mpeg and file size less than 30MB (for a larger size, please contact us to adjust limitations) |
For Email :
Optional Parameters | Sample | Description |
---|---|---|
type | 1 or 2 |
|
subject | Test Subject | Email Subject |
from_email | test@email.com | Sender Email |
to | test@email.com,test1@email.com | Receivers emails separated with (,) |
cc | test@email.com,test1@email.com | Receivers emails separated with (,) |
bcc | test@email.com,test1@email.com | Receivers emails separated with (,) |
body | Mail Body | Mail Body |
public_message | 1 (Yes public ) or 2 (No )(if not send by default 2 ) | Public Message |
track_open | 1 (Yes Track ) or 2 (No )(if not send by default 2 ) | Track Message |
track_click | 1 (Yes Clicked ) or 2 (No )(if not send by default 2 ) | Clicked Message |
upfile | POST FILES (hasAttachments paramter send with true in case of upload files ) | Attachments |
deal_name or deal_id | Deals related to this email (send deal_id in case of exist deal or deal_name in case of new one ) | Deal |
activity_name or activity_id | Tasks related to this email (send activity_id in case of exist task or activity_name in case of new one ) | Activities |
For Notes :
Optional Parameters | Sample | Description |
---|---|---|
note_id | 789 | ID for the existing note (in case of editing). |
note_title | string | Title for the note |
note_added_by | 234 | Added by note |
description | string | description for the note |
For Adding task :
Optional Parameters | Sample | Description |
---|---|---|
task_name | string | Title for the task |
note | string | note for the task |
task_type | string | if no matching value exists, a new task type will be added to the custom task types under customization section |
due_date | 2020-06-07 | in the format YYYY-mm-dd |
due_time | 04:06 | in the format HH:MM in 24hrs format |
owner_id | ||
assigned_to_id | ||
who_can_see |
For registering a meeting or event :
Optional Parameters | Sample | Description |
---|---|---|
meeting_title | string | |
meeting_place | string | |
meeting_link | string | |
meeting_date | string | Start date for the meeting/event, Accepted Format YYYY-MM-DD |
meeting_time | string | Start time for the meeting/event, Accepted Format HH:mm (24hrs) |
meeting_end_date | string | End date for the meeting/event, Accepted Format YYYY-MM-DD |
meeting_end_time | date | End time for the meeting/event, Accepted Format HH:mm (24hrs) |
meeting_notes | string |
Example:
Example :
https://hubbucs.com/site/api/hubb/contact_actions?key=12134651Gsuid7349&email=XXXXX&password=XXXXX&action=XXXX
Response :
- {
- "message":"success",
- "contact_id":"562",
- "external_id":"92332"
- }
- ------OR------
- {
- "error_message":"error message"
- }