API Token
API Token can be requested from Admin of CRM or BusinessLabs' team.
Usage of the API
Available commands of the API are described below, along with their responses.
For this example, we will use a dummy token and a random command.
Let’s say your new token is jEheVytlAoFl7F8MqUQ
7jAo2hOXASztXjEheVytlAoFl7F8MqUQ
7jAo2hOXASztXjEheVytlAoFl7F8MqUQ7j
Ao2hOXASztX and that you need to list all available customers of the PMP's installation, using the API, through a cURL request.
Command Request
curl -H "authtoken: jEheVytlAoFl7F8MqUQ7jAo2hOXASztXjEheVytlAoFl7F8MqUQ7jAo2hOXASztXjEheVytlAoFl7F8MqUQ7jAo2hOXASztX" https://mysite.com/api/customers
Response of command request
[
{
"stripe_id" : null,
"active" : "1",
"vat" : "1234567890",
"address" : "Test Address",
"billing_country" : "0",
"phonenumber" : "1234567890",
"registration_confirmed" : "1",
"longitude" : null,
"billing_city" : "",
"state" : "Test State",
"shipping_zip" : "",
"billing_zip" : "",
"city" : "Test City",
"shipping_country" : "0",
"billing_street" : "",
"datecreated" : "2019-11-29 12:34:56",
"company" : "Jk Technologies",
"shipping_street" : "",
"zip" : "123456",
"billing_state" : "",
"leadid" : null,
"addedfrom" : "8",
"userid" : "3",
"default_language" : "english",
"shipping_state" : "",
"show_primary_contact" : "0",
"country" : "102",
"default_currency" : "3",
"shipping_city" : "",
"latitude" : null,
"website" : "https://jkdot.com"
},
{
"website" : "https://www.test.com",
"latitude" : null,
"default_currency" : "0",
"shipping_city" : "London",
"country" : "235",
"show_primary_contact" : "0",
"shipping_state" : "Greater London",
"default_language" : "",
"addedfrom" : "1",
"userid" : "1",
"leadid" : null,
"billing_state" : "Greater London",
"zip" : "WC1 ASW",
"shipping_street" : "123 Road Street",
"company" : "Sample Company LTD",
"datecreated" : "2019-04-02 13:38:28",
"billing_street" : "123 Road Street",
"shipping_country" : "235",
"city" : "London",
"billing_zip" : "WC1 ASW",
"shipping_zip" : "WC1 ASW",
"longitude" : null,
"registration_confirmed" : "1",
"billing_city" : "London",
"state" : "Greater London",
"phonenumber" : "+44 210 7298299",
"billing_country" : "235",
"address" : "123 Road Street",
"vat" : "123456789",
"active" : "1",
"stripe_id" : null
}
]
End of documentation intro part. Below, you will find all available commands that can be used with Rest API of BusinessLabs PMP API, along with their methods.
Customer
POST
api/customers
Customer - Add New Customer
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
company | String |
Mandatory Customer company. |
vatoptional | String |
Optional Vat. |
phonenumberoptional | String |
Optional Customer Phone. |
websiteoptional | String |
Optional Customer Website. |
groups_inoptional | Number[] |
Optional Customer groups. |
default_languageoptional | String |
Optional Customer Default Language. |
default_currencyoptional | String |
Optional default currency. |
addressoptional | String |
Optional Customer address. |
cityoptional | String |
Optional Customer City. |
stateoptional | String |
Optional Customer state. |
zipoptional | String |
Optional Zip Code. |
countryoptional | String |
Optional country. |
billing_streetoptional | String |
Optional Billing Address: Street. |
billing_cityoptional | String |
Optional Billing Address: City. |
billing_stateoptional | Number |
Optional Billing Address: State. |
billing_zipoptional | String |
Optional Billing Address: Zip. |
billing_countryoptional | String |
Optional Billing Address: Country. |
shipping_streetoptional | String |
Optional Shipping Address: Street. |
shipping_cityoptional | String |
Optional Shipping Address: City. |
shipping_stateoptional | String |
Optional Shipping Address: State. |
shipping_zipoptional | String |
Optional Shipping Address: Zip. |
shipping_countryoptional | String |
Optional Shipping Address: Country. |
{Multipart Form} Request-Example:
array (size=22)
'company' => string 'Themesic Interactive' (length=38)
'vat' => string '123456789' (length=9)
'phonenumber' => string '123456789' (length=9)
'website' => string 'AAA.com' (length=7)
'groups_in' =>
array (size=2)
0 => string '1' (length=1)
1 => string '4' (length=1)
'default_currency' => string '3' (length=1)
'default_language' => string 'english' (length=7)
'address' => string '1 Silk Point' (length=12)
'city' => string 'John Test' (length=9)
'state' => string 'John Test' (length=9)
'zip' => string '700000' (length=6)
'country' => string '243' (length=3)
'billing_street' => string '1 Silk Point' (length=12)
'billing_city' => string 'John Test' (length=9)
'billing_state' => string 'John Test' (length=9)
'billing_zip' => string '700000' (length=6)
'billing_country' => string '243' (length=3)
'shipping_street' => string '1 Silk Point' (length=12)
'shipping_city' => string 'John Test' (length=9)
'shipping_state' => string 'John Test' (length=9)
'shipping_zip' => string '700000' (length=6)
'shipping_country' => string '243' (length=3)
Success 200
Field | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Customer add successful. |
Success-Response:
HTTP/1.1 200 OK
{
"status": true,
"message": "Customer add successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Customer add fail. |
Error-Response:
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Customer add fail."
}
Customer - Delete a Customer
api/delete/customers/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
Customer unique ID. |
Success 200
Field | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Customer Delete Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Customer Delete Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Customer Delete Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Customer Delete Fail."
}
Customer - Request customer information
api/customers/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
customer unique ID. |
Success 200
Field | Type | Description |
---|---|---|
customer | Object |
information. |
HTTP/1.1 200 OK
{
"id": "28",
"name": "Test1",
"description": null,
"status": "1",
"clientid": "11",
"billing_type": "3",
"start_date": "2019-04-19",
"deadline": "2019-08-30",
"customer_created": "2019-07-16",
"date_finished": null,
"progress": "0",
"progress_from_tasks": "1",
"customer_cost": "0.00",
"customer_rate_per_hour": "0.00",
"estimated_hours": "0.00",
"addedfrom": "5",
"rel_type": "customer",
"potential_revenue": "0.00",
"potential_margin": "0.00",
"external": "E",
...
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
No data were found. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "No data were found"
}
Customer - Search Customer Information.
api/customers/search/:keysearch
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
keysearch | String |
Search Keywords. |
Success 200
Field | Type | Description |
---|---|---|
customer | Object |
information. |
HTTP/1.1 200 OK
{
"id": "28",
"name": "Test1",
"description": null,
"status": "1",
"clientid": "11",
"billing_type": "3",
"start_date": "2019-04-19",
"deadline": "2019-08-30",
"customer_created": "2019-07-16",
"date_finished": null,
"progress": "0",
"progress_from_tasks": "1",
"customer_cost": "0.00",
"customer_rate_per_hour": "0.00",
"estimated_hours": "0.00",
"addedfrom": "5",
"rel_type": "customer",
"potential_revenue": "0.00",
"potential_margin": "0.00",
"external": "E",
...
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
No data were found. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "No data were found"
}
Customer - Update a Customer
api/customers/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
company | String |
Mandatory Customer company. |
vatoptional | String |
Optional Vat. |
phonenumberoptional | String |
Optional Customer Phone. |
websiteoptional | String |
Optional Customer Website. |
groups_inoptional | Number[] |
Optional Customer groups. |
default_languageoptional | String |
Optional Customer Default Language. |
default_currencyoptional | String |
Optional default currency. |
addressoptional | String |
Optional Customer address. |
cityoptional | String |
Optional Customer City. |
stateoptional | String |
Optional Customer state. |
zipoptional | String |
Optional Zip Code. |
countryoptional | String |
Optional country. |
billing_streetoptional | String |
Optional Billing Address: Street. |
billing_cityoptional | String |
Optional Billing Address: City. |
billing_stateoptional | Number |
Optional Billing Address: State. |
billing_zipoptional | String |
Optional Billing Address: Zip. |
billing_countryoptional | String |
Optional Billing Address: Country. |
shipping_streetoptional | String |
Optional Shipping Address: Street. |
shipping_cityoptional | String |
Optional Shipping Address: City. |
shipping_stateoptional | String |
Optional Shipping Address: State. |
shipping_zipoptional | String |
Optional Shipping Address: Zip. |
shipping_countryoptional | String |
Optional Shipping Address: Country. |
{
"company": "Themesic",
"vat": "",
"phonenumber": "0123456789",
"website": "",
"default_language": "",
"default_currency": "0",
"country": "243",
"city": "London",
"zip": "700000",
"state": "Quáºn 12",
"address": "1 Silk Point",
"billing_street": "1 Silk Point",
"billing_city": "London",
"billing_state": "Quáºn 12",
"billing_zip": "700000",
"billing_country": "143",
"shipping_street": "",
"shipping_city": "",
"shipping_state": "",
"shipping_zip": "",
"shipping_country": "0"
}
Success 200
Field | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Customer Update Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Customer Update Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Customer Update Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Customer Update Fail."
}
Lead
Lead - Add New Lead
api/leads
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
source | String |
Mandatory Lead source. |
status | String |
Mandatory Lead Status. |
name | String |
Mandatory Lead Name. |
file[]optional | File |
Optional Lead attachments. |
assignedoptional | String |
Optional Lead assigned. |
tagsoptional | String |
Optional Lead tags. |
titleoptional | String |
Optional Position. |
emailoptional | String |
Optional Lead Email Address. |
websiteoptional | String |
Optional Lead Website. |
phonenumberoptional | String |
Optional Lead Phone. |
companyoptional | String |
Optional Lead company. |
addressoptional | String |
Optional Lead address. |
cityoptional | String |
Optional Lead City. |
stateoptional | String |
Optional Lead state. |
default_languageoptional | String |
Optional Lead Default Language. |
descriptionoptional | String |
Optional Lead description. |
custom_contact_dateoptional | String |
Optional Lead From Customer. |
contacted_todayoptional | String |
Optional Lead Contacted Today. |
is_publicoptional | String |
Optional Lead google sheet id. |
array (size=20)
'status' => string '2' (length=1)
'source' => string '6' (length=1)
'assigned' => string '1' (length=1)
'client_id' => string '5' (length=1)
'tags' => string '' (length=0)
'name' => string 'Lead Name' (length=9)
'contact' => string 'Contact A' (length=9)
'title' => string 'Position A' (length=10)
'email' => string 'AAA@gmail.com' (length=13)
'website' => string '' (length=0)
'phonenumber' => string '123456789' (length=9)
'company' => string 'TheCompany' (length=51)
'address' => string '1 Silk Point' (length=53)
'city' => string 'John Test' (length=9)
'state' => string '' (length=0)
'default_language' => string 'english' (length=10)
'description' => string 'Description' (length=11)
'custom_contact_date' => string '' (length=0)
'is_public' => string 'on' (length=2)
'contacted_today' => string 'on' (length=2)
Success 200
Field | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Lead add successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Lead add successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
add fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Lead add fail."
}
Lead - Delete a Lead
api/delete/leads/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
lead unique ID. |
Success 200
Field | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Lead Delete Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Lead Delete Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Lead Delete Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Lead Delete Fail."
}
Lead - Request lead information
api/leads/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
Lead unique ID. |
Success 200
Field | Type | Description |
---|---|---|
Lead | Object |
information. |
HTTP/1.1 200 OK
{
"id": "17",
"hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
"name": "Lead name",
"contact": "",
"title": "",
"company": "Themesic Interactive",
"description": "",
"country": "243",
"zip": null,
"city": "London",
"state": "London",
"address": "1 Silk Point",
"assigned": "5",
"dateadded": "2019-07-18 08:59:28",
"from_form_id": "0",
"status": "0",
"source": "4",
...
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
No data were found. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "No data were found"
}
Lead - Search Lead Information.
api/leads/search/:keysearch
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
keysearch | String |
Search Keywords. |
Success 200
Field | Type | Description |
---|---|---|
Lead | Object |
information. |
HTTP/1.1 200 OK
{
"id": "17",
"hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
"name": "Lead name",
"contact": "",
"title": "",
"company": "Themesic Interactive",
"description": "",
"country": "243",
"zip": null,
"city": "London",
"state": "London",
"address": "1 Silk Point",
"assigned": "5",
"dateadded": "2019-07-18 08:59:28",
"from_form_id": "0",
"status": "0",
"source": "4",
...
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
No data were found. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "No data were found"
}
Lead - Update a lead
api/leads/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
source | String |
Mandatory Lead source. |
status | String |
Mandatory Lead Status. |
name | String |
Mandatory Lead Name. |
assignedoptional | String |
Optional Lead assigned. |
tagsoptional | String |
Optional Lead tags. |
titleoptional | String |
Optional Position. |
emailoptional | String |
Optional Lead Email Address. |
websiteoptional | String |
Optional Lead Website. |
phonenumberoptional | String |
Optional Lead Phone. |
companyoptional | String |
Optional Lead company. |
addressoptional | String |
Optional Lead address. |
cityoptional | String |
Optional Lead City. |
stateoptional | String |
Optional Lead state. |
countryoptional | String |
Optional Lead Country. |
default_languageoptional | String |
Optional Lead Default Language. |
descriptionoptional | String |
Optional Lead description. |
lastcontactoptional | String |
Optional Lead Last Contact. |
is_publicoptional | String |
Optional Lead google sheet id. |
{
"name": "Lead name",
"contact": "contact",
"title": "title",
"company": "Themesic",
"description": "description",
"tags": "",
"city": "London",
"state": "London",
"address": "1 Silk Point",
"assigned": "5",
"source": "4",
"email": "AA@gmail.com",
"website": "themesic.com",
"phonenumber": "123456789",
"is_public": "on",
"default_language": "english",
"client_id": "3",
"lastcontact": "25/07/2019 08:38:04"
}
Success 200
Field | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Lead Update Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Lead Update Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Lead Update Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Lead Update Fail."
}
Milestone
Milestone - Add New Milestone
api/milestones
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
project_id | String |
Mandatory project id. |
name | String |
Mandatory Milestone Name. |
due_date | Date |
Mandatory Milestone Due date. |
descriptionoptional | String |
Optional Milestone Description. |
description_visible_to_customeroptional | String |
Show description to customer. |
milestone_orderoptional | String |
Optional Milestone Order. |
array (size=6)
'project_id' => string '2' (length=1)
'name' => string 'Milestone A' (length=11)
'due_date' => string '30/07/2019' (length=10)
'description' => string 'Description' (length=11)
'description_visible_to_customer' => string 'on' (length=2)
'milestone_order' => string '1' (length=1)
Success 200
Field | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Milestone add successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Milestone add successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Milestone add fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Milestone add fail."
}
Milestone - Delete a Milestone
api/delete/milestones/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
Milestone unique ID. |
Success 200
Field | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Milestone Delete Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Milestone Delete Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Milestone Delete Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Milestone Delete Fail."
}
Milestone - Request Milestones information
api/milestones/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
Milestones unique ID. |
Success 200
Field | Type | Description |
---|---|---|
Milestones | Object |
information. |
HTTP/1.1 200 OK
{
"id": "5",
"name": "MIlestone A",
"description": "",
"description_visible_to_customer": "0",
"due_date": "2019-09-30",
"project_id": "2",
"color": null,
"milestone_order": "1",
"datecreated": "2019-07-19",
"total_tasks": "0",
"total_finished_tasks": "0"
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
No data were found. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "No data were found"
}
Milestone - Search Milestones Information.
api/milestones/search/:keysearch
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
keysearch | String |
Search Keywords. |
Success 200
Field | Type | Description |
---|---|---|
Milestones | Object |
information. |
HTTP/1.1 200 OK
{
"id": "5",
"name": "MIlestone A",
"description": "",
"description_visible_to_customer": "0",
"due_date": "2019-09-30",
"project_id": "2",
"color": null,
"milestone_order": "1",
"datecreated": "2019-07-19",
"total_tasks": "0",
"total_finished_tasks": "0"
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
No data were found. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "No data were found"
}
Milestone - Update a Milestone
api/milestones/:id
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
project_id | String |
Mandatory project id. |
name | String |
Mandatory Milestone Name. |
due_date | Date |
Mandatory Milestone Due date. |
descriptionoptional | String |
Optional Milestone Description. |
description_visible_to_customeroptional | String |
Show description to customer. |
milestone_orderoptional | String |
Optional Milestone Order. |
{
"project_id": "1",
"name": "Milestone A",
"due_date": "30/07/2019",
"description": "Description",
"description_visible_to_customer": "on",
"milestone_order": "1"
}
Success 200
Field | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Milestone Update Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Milestone Update Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | String |
Request status. |
message | String |
Milestone Update Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Milestone Update Fail."
}
Project
Project - Add New Project
api/projects
Header
Field | Type | Description |
---|---|---|
authtoken | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
name | String |
Mandatory Project Name. |
clientid | Number |
Mandatory Related ID. |
billing_type | Number |
Mandatory Billing Type. |
start_date | Date |
Mandatory Project Start Date. |
status | Number |
Mandatory Project Status. |
file[]optional | File |
Optional Project file. |
progress_from_tasksoptional | String |
Optional on or off progress from tasks. |
project_costoptional | String |
Optional Project Cost. |
progressoptional | String |
Optional project progress. |
project_rate_per_houroptional | String |
Optional project rate per hour. |
estimated_hoursoptional | String |
Optional Project estimated hours. |
project_membersoptional | Number[] |
Optional Project members. |
deadlineoptional | Date |
Optional Project deadline. |
tagsoptional | String |
Optional Project tags. |
descriptionoptional | String |
Optional Project description. |
Ticket
Ticket - Add New Ticket
api/tickets
Header
Field | Type | Description |
---|---|---|
Authorization | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
subject | String |
Mandatory Ticket name . |
department | String |
Mandatory Ticket Department. |
contactid | String |
Mandatory Ticket Contact. |
userid | String |
Mandatory Ticket user. |
project_idoptional | String |
Optional Ticket Project. |
messageoptional | String |
Optional Ticket message. |
serviceoptional | String |
Optional Ticket Service. |
assignedoptional | String |
Optional Assign ticket. |
ccoptional | String |
Optional Ticket CC. |
priorityoptional | String |
Optional Priority. |
tagsoptional | String |
Optional ticket tags. |
{Multipart Form} Request-Example:
array (size=11)
'subject' => string 'ticket name' (length=11)
'contactid' => string '4' (length=1)
'userid' => string '5' (length=1)
'department' => string '2' (length=1)
'cc' => string '' (length=0)
'tags' => string '' (length=0)
'assigned' => string '8' (length=1)
'priority' => string '2' (length=1)
'service' => string '2' (length=1)
'project_id' => string '' (length=0)
'message' => string '' (length=0)
Success 200
Field | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Ticket add successful. |
Success-Response:
HTTP/1.1 200 OK
{
"status": true,
"message": "Ticket add successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Ticket add fail. |
Error-Response:
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Ticket add fail."
}
Ticket - Delete a Ticket
api/delete/tickets/:id
Header
Field | Type | Description |
---|---|---|
Authorization | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
Ticket unique ID. |
Success 200
Field | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Ticket Delete Successful. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Ticket Delete Successful."
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
Ticket Delete Fail. |
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Ticket Delete Fail."
}
Ticket - Request Ticket information
api/tickets/:id
Header
Field | Type | Description |
---|---|---|
Authorization | String |
Basic Access Authentication token. |
Parameter
Field | Type | Description |
---|---|---|
id | Number |
Ticket unique ID. |
Success 200
Field | Type | Description |
---|---|---|
Ticket | Object |
information. |
HTTP/1.1 200 OK
{
"ticketid": "7",
"adminreplying": "0",
"userid": "0",
"contactid": "0",
"email": null,
"name": "Trung bình",
"department": "1",
"priority": "2",
"status": "1",
"service": "1",
"ticketkey": "8ef33d61bb0f26cd158d56cc18b71c02",
"subject": "Ticket ER",
"message": "Ticket ER",
"admin": "5",
"date": "2019-04-10 03:08:21",
"project_id": "5",
"lastreply": null,
"clientread": "0",
"adminread": "1",
"assigned": "5",
"line_manager": "8",
"milestone": "27",
...
}
Error 4xx
Name | Type | Description |
---|---|---|
status | Boolean |
Request status. |
message | String |
The id of the Ticket was not found. |
Did you find this article useful?
Related Articles
-
Video: Overview of the Project Management Platform
Checkout next articles to learn more about the platform and how to use the platform to make your pro... -
How to Manage and Update your Profile and Company Details
This video will show you how to login in the project management platform, how to update your persona... -
How to Send Payments through Xoom - the PayPal Service
Hello Everyone,In this article, we have detailed the steps to use xoom to send us the payment for th... -
How to create Support Tickets in PMP For BusinessLabs team
Hello,The video can help you create a support ticket.... -
API of PMP CRM
Ticket Ticket - Add New Ticket 0.0.0 POST api/tickets Header Field Type Description...