Documentation

LogIn

This API is used to add a new Company in the CRM .
if the Company found (unique by Email), the info for the Company will be updated not adding a new record.

Method: Get/Post

Base URL : https://hubbucs.com/site/api/hubb/add_company
Mandatory Parameters Sample Description
key 374593457034859 The account API key, you can get from company settings > API settings
email newcontact@url.com email for user to authenticate
password 123456 Password for user to authenticate


Optional Parameters Sample Description
company_id 876566 the Company id, if exists, the data below will be used to update the Company info
name New Comapny Name for the company
company_email newcompany@url.com email for the new company, if a company with the email already exists, the company will be updated
employee_range 10 - 100 Company Employee Range
description description Company description
website www.company.com Company Website
main_phone 5645645456 The phone number for the company
companycollaborator_email user@email.com Email for the user to be assigned as the company Full Access Collaborator on the CRM, it must be a valid email for a valid active user under the company account or will be neglected
companycollaboratoronly_email user@email.com Email for the user to be assigned as the company collaborators only on the CRM, it must be a valid email for a valid active user under the company account or will be neglected
sector Sector Name Name of the sector company will related to .(If not found will be added as new )
companyowner_email user@email.com Email for the user to be assigned as the company owner on the CRM, it must be a valid email for a valid active user under the company account or will be neglected
who_can_see 1 Or 2 Or 3 IDs for who given Permission
tags new customer, campaign1, call me Tags you want to add to the company to use it later on, add as many tags , split by ","
remove_tags tag1, tag2 Tags you want to remove from the company if the company already exists , split by ","

Example:


				

Example :

https://hubbucs.com/site/api/hubb/add_company?key=12134651Gsuid7349&email=XXXXX[&Optional_parameter1=XXXXX&Optional_parameter2=XXXXX]

Response :

  1. {
  2. "message":"success",
  3. "company_id":"Company ID",
  4. }
  5. ------OR------
  6. {
  7. "error_message":"error message"
  8. }