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 a new tickets created by customers (CRM Contacts) under the company account in the Service application (Ticketing and project management application provided by HUBB UCS)
Method: Get/Post
Base URL : https://hubbucs.com/site/api/add_ticket
Method: Get/Post
Base URL : https://hubbucs.com/site/api/add_ticket
Mandatory Parameters | Sample | Description |
---|---|---|
key | 374593457034859 | The company account API key, you can get from company settings > API settings |
ticket_project | project XY | The project which will the ticket be created under |
ticket_type | support ticket | The type of the ticket/Issue |
Optional Parameters | Sample | Description |
---|---|---|
ticket_summary | String/Text | Summary or title of the ticket |
ticket_description | String/Text | Description for the ticket |
support_email | String/Text | Email Account used to reply to the customer (it must be a connected Email account) |
assign_to_email | Email of an active user on the account to be assigned to the ticket | |
auto_assign | 1 or 2 | 1: will auto assign the ticket to the list of assignee defined in the project (Default value if not sent) 2: will not assign |
group_assign | 1 or 2 | 1: will assign the ticket to group id sent below. 0: will not assign to group (Default value if not sent) |
group_assign_id | 1 or 2 | group ID that ticket will assign to . |
notify_by_email | 1 or 2 | 1: will notify the ticket assignee (Default value if not sent) 2: will not notify |
send_recieve_confirmation | 1 or 2 | 1: will notify the ticket creator/adder that request recieved (Default value if not sent) 2: will not notify |
Contact Related Parameters | ||
created_by_user | Email of an active user on the account to be marked as the creator of the ticket, Note: if not sent, the contact will be marked as the creator of the ticket |
|
contact_id | 876566 | the contact id for the Ticket Creator, if exists, the data below will be used to update the contact info |
newcontact@url.com | email for the new contact, if a contact with the email already exists, the contact will be updated | |
watchers | Michael Gilbert |
list of ticket watchers seperated by comma |
phone | 5645645456 | The phone number for the contact, if a contact with the phone already exists, the contact will be updated |
create_new_contact | 1 or 2 | 1: create new contact if not exists (Default value if not sent) 2: Don't create new contact if not exists |
match_with_email | Possible Values (1 OR 2) | 1: Yes match with email (default value), 2 No: dont match with email |
match_with_phone | Possible Values (1 OR 2) | 1: Yes match with phone , 2 No: dont match with 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 |
fullname | mike douglas | The Full name for the contact (if exists, firstname and lastname parameters will be ignored) |
firstname | mike | The first name for the contact |
lastname | douglas | The last name for the contact |
new_company_name | company XY | A new company for the contact, which will be created and link the contact to it, if the contact wasn't linked to a company before, if the contact was linked to a company, this will be ignored |
facebook ULR or Facebook name | The Facebook page or name for the contact | |
twitter ULR or twitter name | The twitter account for the contact | |
skype | skype username | The skype username account for the contact |
Linkedin username | The Linkedin username account for the contact | |
pinterest username | The pinterest account for the contact | |
googlePlus | googlePlus username | The googlePlus account for the contact |
instagram username | The instagram account for the contact | |
birthdate | date | Birth Date for the contact ( format YYYY-MM-DD) |
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_status | text | status of contact, if not exists in the settings, it will be added automatically |
contact_type | text | Contact type, if not exists in the settings, it will be added automatically |
tags | new customer, campaign1, call me | Tags you want to add to the contact to use it later on, add as many tags , split by "," |
remove_tags | new customer, campaign1, call me | Tags you want to remove from the contact if the contact already exists , split by "," |
notifyToEmail | user1@company.com | If exists, An email will be sent to notify when a new contact added via the API |
notifyEmailSubject | New Contact Added | Subject of the notification email for new contacts |
contactcollaborator_email | user@email.com | Email for the user to be assigned as the contact 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 |
contactcollaborator_group | group name | the user group name to assigned contacts to it in a round robin If the parameter "contactcollaborator_email" is sent, this parameter will be neglected and "contactcollaborator_email" will override it |
contactcollaboratoronly_email | user@email.com | Email for the user to be assigned as the contact collaborators only on the CRM, it must be a valid email for a valid active user under the company account or will be neglected |
contactcollaboratoronly_group | group name | the user group name to assigned contacts to it in a round robin If the parameter "contactcollaboratoronly_email" is sent, this parameter will be neglected and "contactcollaboratoronly_email" will override it |
contactowner_email | user@email.com | Email for the user to be assigned as the contact owner on the CRM, it must be a valid email for a valid active user under the company account or will be neglected |
contactowner_group | group name | the user group name to assigned contacts to it in a round robin If the parameter "contactowner_email" is sent, this parameter will be neglected and "contactowner_email" will override it |
email_notify_owner | Possible Values (1 OR 2) | if set to 1 (default value): a notification email will be sent to the contact owner as well, if set to 2: no notification email will be sent to the contact owner | attachments | Array of Files | you can submit one or more files as array attachments[], if you want to submit attachment files, Must use POST method and Multi-part Allowed files type: (JPG, GIF, BMP, Excel, CSV, Word, Powerpoint, PDF, Text, Zipped file) AND total files size must be less than 100M if one of the files doesn't match this critria it will be ingonred and not saved |
address_street | 4806 Reppert Coal Road | Street Address |
address_city | Bloomfield Township | City Name |
address_zipcode | 48302 | Zipcode Number |
address_state | FL or Florida | State name or State Code |
increase_number_of_times_contacted | 1 or 2 | 1: (default value) will not increase number of times contacted counter for the contact, 2: will increase the number of times this contact has been contacted |
Example:
Example :
https://hubbucs.com/site/api/add_ticket?key=12134651Gsuid7349&ticket_project=XXXXX&ticket_type=XXXXX[&Optional_parameter1=XXXXX&Optional_parameter2=XXXXX]
Response :
- {
- "message":"success",
- "ticket_key":"PROJ-654982",
- "customer_ticket_number":"356594",
- "contact_id":"95365",
- "assigned_to":"Name of the assignee"
- "account_ticket_id":"a sequence number for the ticket under the account"
- }
- ------OR------
- {
- "error_message":"error message"
- }