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 invite user .
Method: Get/Post
Base URL : https://hubbucs.com/site/api/user_invite
Method: Get/Post
Base URL : https://hubbucs.com/site/api/user_invite
Mandatory Parameters | Sample | Description |
---|---|---|
key | 374593457034859 | The company account API key, you can get from company settings > API settings |
newcontact@url.com | email for user login | |
invited_email | newcontact@url.com | email for user to invite |
invited_name | John Dick | inviter Name |
Optional Parameters | Sample | Description |
---|---|---|
Account_privilege | 1 / 3 | 1 user (default if not found ) , 3 Account Admin |
service1_Selfrecords_only (Access only to Owned or invited to collaborate records) | 1 / 2 | 2 allow (default in case not found) , 1 not allowed |
inviter_comment | Test Comment | Special Message to send with the invitation . |
employee_group_names | workgroup1,workgroup2,workgroup3 | Work groups that user assigned (one or multiple separated by comma ) |
service_status14 | 1 / 2 | BOSS Service (2 active (default) , 1 deactive) |
service14_view_only_assigned | 1 / 2 / 3 | View Tickets : (1 Can View All Tickets for all projects , 2 Can View All Tickets in projects participating in , 3 Can View only Tickets assigned to (default) ) |
service14_can_view_contacts | 1 | View Tickets Related Contacts : ( 1 NO , 2 YES (default) ) |
service_status1 | 1 / 2 | BOSS CRM (2 active (default) , 1 deactive) |
service1_sales | 1 / 2 / 3 | Sales : (1 No Access , 2 Read Only Access" , 3 Read/Write Access (default) ) |
service1_marketing | 1 | Marketing : (1 No Access , 2 Read Only Access" , 3 Read/Write Access (default) ) |
service1_tags_to_users | 1 | Manage Tags for records : (1 No, View Only , 2 Can Assign tags from existing tags , 3 Can Assign & create new tags (default) ) |
service_status2 | 1 / 2 | BOSS PHONE (2 active (default) , 1 deactive) |
service2_manage_extensions | 1 / 2 | Manage Lines/Extensions : (1 No , 2 Yes (default) ) |
service2_manage_DID | 1 / 2 | Manage Phone Numbers : (1 No , 2 Yes (default) ) |
service2_view_call_log | 1 / 2 | Manage Phone Numbers : (1 No , 2 Yes (default) ) |
Example:
Example :
https://hubbucs.com/site/api/user_invite?key=12134651Gsuid7349&invited_email=XXXXX&invited_name=XXX[&Optional_parameter1=XXXXX&Optional_parameter2=XXXXX]
Response :
- {
- "message":"success",
- }
- ------OR------
- {
- "error_message":"error message"
- }