{"info":{"_postman_id":"5c886c4c-6816-4419-8ec6-a2fd4f0f5367","name":"SupportCandy (v1) Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"<html><head></head><body></body></html>","owner":"7356551","collectionId":"5c886c4c-6816-4419-8ec6-a2fd4f0f5367","publishedId":"S1TZzFxc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-06-10T09:02:47.000Z"},"item":[{"name":"/login","id":"1cc35a77-03d3-49c6-bc16-e84fc5aaa9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/login?username=YOUR_USERNAME&password=YOUR_PASSWORD&secret_key=YOUR_SECRET_KEY","description":"<p>This will check user login details and return \"auth_user\" and \"auth_token\" uppon successful validation.\nThis will be used for making API requests as registered user.</p>\n<p>You should save this to your application at safe place for further user.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","login"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) Email/Username of wordpress user account.</p>\n","type":"text/plain"},"key":"username","value":"YOUR_USERNAME"},{"description":{"content":"<p>(Required) Password of wordpress user account.</p>\n","type":"text/plain"},"key":"password","value":"YOUR_PASSWORD"},{"description":{"content":"<p>(Required) Secret Key given in Rest API Setting of SupportCandy.</p>\n","type":"text/plain"},"key":"secret_key","value":"YOUR_SECRET_KEY"}],"variable":[]}},"response":[],"_postman_id":"1cc35a77-03d3-49c6-bc16-e84fc5aaa9f9"},{"name":"/guestTicketFormFields","id":"05004f02-f569-4b35-bbe6-68a5c2284c20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/guestTicketFormFields?secret_key=YOUR_SECRET_KEY","description":"<p>Returns guest ticket form fields.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","guestTicketFormFields"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) Secret Key given in Rest API Setting of SupportCandy.</p>\n","type":"text/plain"},"key":"secret_key","value":"YOUR_SECRET_KEY"}],"variable":[]}},"response":[],"_postman_id":"05004f02-f569-4b35-bbe6-68a5c2284c20"},{"name":"/ticketFormFields","id":"05a81756-8fa5-4d1c-ae5d-eb1ff4e6b1a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/ticketFormFields?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Returns ticket form fields for regustered user. This will not have Name and Email field.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","ticketFormFields"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"05a81756-8fa5-4d1c-ae5d-eb1ff4e6b1a2"},{"name":"/agentonlyFields","id":"efa737b5-a611-487a-8e8e-250c539e6b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/agentonlyFields?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Returns list of agentonly custom fields.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","agentonlyFields"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"efa737b5-a611-487a-8e8e-250c539e6b9e"},{"name":"/statuses","id":"1a0c3806-b80d-4e76-89b9-22f4541d7e07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourdomain.com/wp-json/supportcandy/v1/statuses","description":"<p>Return list of ticket statuses.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","statuses"],"host":["yourdomain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a0c3806-b80d-4e76-89b9-22f4541d7e07"},{"name":"/statuses/{id}","id":"ab797383-219e-4cca-a31f-265ea50c7078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourdomain.com/wp-json/supportcandy/v1/statuses/{id}","description":"<p>Return status information for given status id.</p>\n<p>e.g.\n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/statuses/3\">https://yourdomain.com/wp-json/supportcandy/v1/statuses/3</a></p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","statuses","{id}"],"host":["yourdomain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab797383-219e-4cca-a31f-265ea50c7078"},{"name":"/categories","id":"be567db7-f4d2-40ac-98cd-6745fa0b0ea7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourdomain.com/wp-json/supportcandy/v1/categories","description":"<p>Return list of ticket categories.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","categories"],"host":["yourdomain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"be567db7-f4d2-40ac-98cd-6745fa0b0ea7"},{"name":"/categories/{id}","id":"dc159c95-939e-4cf3-ad21-edc8dcd2c669","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourdomain.com/wp-json/supportcandy/v1/categories/{id}","description":"<p>Returns information of given category id.</p>\n<p>e.g.\n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/categories/15\">https://yourdomain.com/wp-json/supportcandy/v1/categories/15</a></p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","categories","{id}"],"host":["yourdomain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc159c95-939e-4cf3-ad21-edc8dcd2c669"},{"name":"/priorities","id":"133b0dd6-5a68-4632-ba5e-e356335d2046","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourdomain.com/wp-json/supportcandy/v1/priorities","description":"<p>Returns list of ticket priorities.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","priorities"],"host":["yourdomain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"133b0dd6-5a68-4632-ba5e-e356335d2046"},{"name":"/priorities/{id}","id":"0fddb383-11c8-46b7-83d5-cf42ea53e928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourdomain.com/wp-json/supportcandy/v1/priorities/{id}","description":"<p>Returns information of given priority id.</p>\n<p>e.g.\n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/priorities/7\">https://yourdomain.com/wp-json/supportcandy/v1/priorities/7</a></p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","priorities","{id}"],"host":["yourdomain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fddb383-11c8-46b7-83d5-cf42ea53e928"},{"name":"/agents","id":"8109cb51-9112-4df5-b292-b516e6e5b479","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/agents?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Return list of all registered supportcandy agents.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","agents"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"8109cb51-9112-4df5-b292-b516e6e5b479"},{"name":"/agents/{id}","id":"fdc12a0d-204b-423b-8466-da6d40cebec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/agents/{id}?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Returns information of given agent id.</p>\n<p>e.g.\n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/agents/35?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN\">https://yourdomain.com/wp-json/supportcandy/v1/agents/35?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN</a></p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","agents","{id}"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"fdc12a0d-204b-423b-8466-da6d40cebec2"},{"name":"/filters","id":"6e8012bb-ce91-4385-8aeb-ba28c59a8ed7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/filters?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Return list of ticket default and custom filters.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","filters"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"6e8012bb-ce91-4385-8aeb-ba28c59a8ed7"},{"name":"/tickets","id":"64e886da-ec77-4a6c-94b2-254986ce3ddf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&current_page=PAGE_NUMBER&number_of_tickets=NUMBER_OF_TICKETS_PER_PAGE&orderby=ORDERBY_OF_TICKETS&order=ORDER_OF_TICKETS&filter_key=FILTER_SLUG OR CUSTOM_FILTER_ID&search=FILTER_STRING","description":"<p>Show  all tickets.</p>\n<p>It can be show result on current page, number of tickets, orderby , order and filter key.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Optional) Current page based on number of tickets per page. (Default: 1)</p>\n","type":"text/plain"},"key":"current_page","value":"PAGE_NUMBER"},{"description":{"content":"<p>(Optional) Number of ticket per page . (Default: 20)</p>\n","type":"text/plain"},"key":"number_of_tickets","value":"NUMBER_OF_TICKETS_PER_PAGE"},{"description":{"content":"<p>(Optional) Orderby field slug. (Default: as per setting)</p>\n","type":"text/plain"},"key":"orderby","value":"ORDERBY_OF_TICKETS"},{"description":{"content":"<p>(Optional) Order of orderby given. (Default: DESC)</p>\n","type":"text/plain"},"key":"order","value":"ORDER_OF_TICKETS"},{"description":{"content":"<p>(Optional) Core filter slug or custom filter id. Refer \"/tickets/filters\" api to get list of all filter keys. (Default: all)</p>\n","type":"text/plain"},"key":"filter_key","value":"FILTER_SLUG OR CUSTOM_FILTER_ID"},{"description":{"content":"<p>(Optional) Search string for current filter. (Default: Empty)</p>\n","type":"text/plain"},"key":"search","value":"FILTER_STRING"}],"variable":[]}},"response":[],"_postman_id":"64e886da-ec77-4a6c-94b2-254986ce3ddf"},{"name":"/tickets/{id}","id":"65bc6c10-5126-46fa-81c4-2aa39195736c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/{id}?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Returns information of given ticket id.</p>\n<p>e.g.\n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/tickets/5?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN\">https://yourdomain.com/wp-json/supportcandy/v1/tickets/5?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN</a></p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","{id}"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"65bc6c10-5126-46fa-81c4-2aa39195736c"},{"name":"/tickets/{id}/threads","id":"8c2f8216-8b7f-4745-b3b2-1238ab6b31d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/{id}/threads?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&current_page=PAGE_NUMBER&no_of_threads=NUMBER_OF_THREADS_PER_PAGE&order=THREAD_ORDER","description":"<p>Returns information of given ticket id threads.</p>\n<p>You can change current page, number of threads per page and order of threads to appeared.</p>\n<p>e.g. \n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/tickets/5/threads?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN&amp;current_page=PAGE_NUMBER&amp;no_of_threads=NUMBER_OF_TICKETS_PER_PAGE&amp;order=THREAD_ORDER\">https://yourdomain.com/wp-json/supportcandy/v1/tickets/5/threads?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN&amp;current_page=PAGE_NUMBER&amp;no_of_threads=NUMBER_OF_TICKETS_PER_PAGE&amp;order=THREAD_ORDER</a></p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","{id}","threads"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(optional) Current page based on number of threads per page . (Default: 1)</p>\n","type":"text/plain"},"key":"current_page","value":"PAGE_NUMBER"},{"description":{"content":"<p>(Optional) Number of threads per page . (Default: 20)</p>\n","type":"text/plain"},"key":"no_of_threads","value":"NUMBER_OF_THREADS_PER_PAGE"},{"description":{"content":"<p>(Optional) ASC or DESC for orderby date. (Default: DESC)</p>\n","type":"text/plain"},"key":"order","value":"THREAD_ORDER"}],"variable":[]}},"response":[],"_postman_id":"8c2f8216-8b7f-4745-b3b2-1238ab6b31d7"},{"name":"/threads/historyId","id":"6586aea2-e133-4c3c-be31-6af96b450da1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/threads/historyId?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Return the current history id of ticktes threads.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","threads","historyId"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"6586aea2-e133-4c3c-be31-6af96b450da1"},{"name":"/threads/history","id":"6fadbdb0-b463-4398-932c-d5e77716a791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/threads/history?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&historyId=HISTORY_ID&current_page=PAGE_NUMBER&no_of_threads=NUMBER_OF_TICKET_THREADS","description":"<p>Return the all tickets threads history.It will give the information of ticket all threads.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","threads","history"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Required) Last thread history id saved in your application. You can refer \"/threads/historyId\" api to check if there are any new threads available for \nauth_user.</p>\n","type":"text/plain"},"key":"historyId","value":"HISTORY_ID"},{"description":{"content":"<p>(Optional) Current page based on number of threads per page. (Default: 1)</p>\n","type":"text/plain"},"key":"current_page","value":"PAGE_NUMBER"},{"description":{"content":"<p>(Optional) Number of threads per page. (Default: 20)</p>\n","type":"text/plain"},"key":"no_of_threads","value":"NUMBER_OF_TICKET_THREADS"}],"variable":[]}},"response":[],"_postman_id":"6fadbdb0-b463-4398-932c-d5e77716a791"},{"name":"/tickets/addRegisteredUserTicket","id":"8d6ccf47-d171-4bf1-bc40-08f907544a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wpsc/wp-json/supportcandy/v1/tickets/addRegisteredUserTicket?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&fields_data={\"FIELD1_SLUG\":\"FIELD1_VALUE\",\"FIELD2_SLUG\":\"FIELD2_VALUE\"}  ","description":"<p>Create registerd user ticket as per given information.The data  should be in json and in key value pair.</p>\n<p>e.g fields_data : {\"ticket_subject\" :\"I am subject field\"} in this form.</p>\n","urlObject":{"protocol":"https","path":["wpsc","wp-json","supportcandy","v1","tickets","addRegisteredUserTicket"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Required) jSon string for fields to update. As shown, fields can have single or multiple values (e.g. Text Field has Single value whereas checkbox can have multiple values). You have to send field data in key value  pair (e .g support field_slug is ticket_subject then send value {\"ticket_subject\": \" I am subject\"} ) .</p>\n","type":"text/plain"},"key":"fields_data","value":"{\"FIELD1_SLUG\":\"FIELD1_VALUE\",\"FIELD2_SLUG\":\"FIELD2_VALUE\"}  "}],"variable":[]}},"response":[],"_postman_id":"8d6ccf47-d171-4bf1-bc40-08f907544a34"},{"name":"/tickets/addGuestTicket","id":"b8893835-09a9-46c0-a07b-765f2304a972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/addGuestTicket?secret_key=YOUR_SECRET_KEY&fields_data={\"FIELD1_SLUG\":\"FIELD1_VALUE\",\"FIELD2_SLUG\":\"FIELD2_VALUE\"}  ","description":"<p>Create guest user ticket as per given information.The data  should be in json and in key value pair.It will required name and email of user.</p>\n<p>e.g fields_data : {\"ticket_subject\" :\"I am subject field\"} in this form.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","addGuestTicket"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) Secret Key given in Rest API Setting of SupportCandy.</p>\n","type":"text/plain"},"key":"secret_key","value":"YOUR_SECRET_KEY"},{"description":{"content":"<p>(Required) jSon string for fields to update. As shown, fields can have single or multiple values (e.g. Text Field has Single value whereas checkbox can have multiple values). You have to send field data in key value  pair (e .g support field_slug is ticket_subject then send value {\"ticket_subject\": \" I am subject\"} ) .</p>\n","type":"text/plain"},"key":"fields_data","value":"{\"FIELD1_SLUG\":\"FIELD1_VALUE\",\"FIELD2_SLUG\":\"FIELD2_VALUE\"}  "}],"variable":[]}},"response":[],"_postman_id":"b8893835-09a9-46c0-a07b-765f2304a972"},{"name":"/tickets/{id}/addReply","id":"cace191b-d0ed-402f-8f5c-dcfec4eb2501","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/{id}/addReply?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&reply_body=Adding reply&attachments={\"attachments\":[\"ATTACHMENT_ID\"]}","description":"<p>Add ticket reply to given ticket id.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","{id}","addReply"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route. user.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Required) Reply body.</p>\n","type":"text/plain"},"key":"reply_body","value":"Adding reply"},{"description":{"content":"<p>(Opional) jSon representation for array of attachment ids.</p>\n","type":"text/plain"},"key":"attachments","value":"{\"attachments\":[\"ATTACHMENT_ID\"]}"}],"variable":[]}},"response":[],"_postman_id":"cace191b-d0ed-402f-8f5c-dcfec4eb2501"},{"name":"/tickets/{id}/addNote","id":"9832f2c6-d7cd-4918-bf22-6feaa865c45b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/{id}/addNote?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&note_body=Adding note&attachments={\"attachments\":[\"ATTACHMENTS_ID\"]}","description":"<p>Add private note to given ticket id.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","{id}","addNote"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Required) Note body.</p>\n","type":"text/plain"},"key":"note_body","value":"Adding note"},{"description":{"content":"<p>(Opional) jSon representation for array of attachment ids.</p>\n","type":"text/plain"},"key":"attachments","value":"{\"attachments\":[\"ATTACHMENTS_ID\"]}"}],"variable":[]}},"response":[],"_postman_id":"9832f2c6-d7cd-4918-bf22-6feaa865c45b"},{"name":"/tickets/{id}/updateFields","id":"5f031aec-dfe8-4ada-a60a-0ac4bf08e882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/{id}/updateFields?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&fields_data={\"FIELD1_SLUG\":\"FIELD1_VALUE\",\"FIELD2_SLUG\":\"FIELD2_VALUE\"}","description":"<p>Here agents can update ticket fields of given ticket id.</p>\n<p>e.g.\n{\"ticket_status\" : \"5\"}</p>\n<p>it will update ticket status of given ticket id.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","{id}","updateFields"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Required) jSon string for fields to update. As shown, fields can have single or multiple values (e.g. Text Field has Single value whereas checkbox can have multiple values). You have to send field data accordingly.You have to send field data in key value  pair (e .g support field_slug is ticket_subject then send value {\"ticket_subject\": \" I am subject\"} ) .</p>\n","type":"text/plain"},"key":"fields_data","value":"{\"FIELD1_SLUG\":\"FIELD1_VALUE\",\"FIELD2_SLUG\":\"FIELD2_VALUE\"}"}],"variable":[]}},"response":[],"_postman_id":"5f031aec-dfe8-4ada-a60a-0ac4bf08e882"},{"name":"/tickets/attachGuestFile","id":"72617e3a-3391-4598-bb4d-d9935f180ba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/attachGuestFile?secret_key=YOUR_SECRET_KEY","description":"<p>Return the guest ticket attachmets ids.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","attachGuestFile"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) Secret Key given in Rest API Setting of SupportCandy.</p>\n","type":"text/plain"},"key":"secret_key","value":"YOUR_SECRET_KEY"}],"variable":[]}},"response":[],"_postman_id":"72617e3a-3391-4598-bb4d-d9935f180ba0"},{"name":"/tickets/attachRegisteredUserFile","id":"e308341c-d12a-459e-a7c0-fda47657eb9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/attachRegisteredUserFile?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Return all registered user attachments ids that are attached. </p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","attachRegisteredUserFile"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"e308341c-d12a-459e-a7c0-fda47657eb9e"},{"name":"/tickets/autocompleteSuggestions","id":"9e867535-180a-4153-a1a8-976b709c7ae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://yourdomain.com/wp-json/supportcandy/v1/tickets/autocompleteSuggestions?auth_user=AUTH_USER&auth_token=AUTH_TOKEN&field_slug=FIELD_SLUG&search=SEARCH_TERM","description":"<p>Return given field slug values.</p>\n<p>e.g. field_slug is ticket_status then it will return the ticket statuses of ticket.</p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","tickets","autocompleteSuggestions"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"},{"description":{"content":"<p>(Required) Slug of the field of which you want to get suggestions.</p>\n","type":"text/plain"},"key":"field_slug","value":"FIELD_SLUG"},{"description":{"content":"<p>(Optional) Search term for autocomplete suggestions. Return top 5 suggestions.</p>\n","type":"text/plain"},"key":"search","value":"SEARCH_TERM"}],"variable":[]}},"response":[],"_postman_id":"9e867535-180a-4153-a1a8-976b709c7ae7"},{"name":"/deleteTickets/{id}","id":"359abd71-3bfa-48e7-92ee-d8888f06b05f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://yourdomain.com/wp-json/supportcandy/v1/deleteTickets/{id}?auth_user=AUTH_USER&auth_token=AUTH_TOKEN","description":"<p>Delete the given ticket id.</p>\n<p>e.g. \n<a href=\"https://yourdomain.com/wp-json/supportcandy/v1/deleteTickets/25?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN\">https://yourdomain.com/wp-json/supportcandy/v1/deleteTickets/25?auth_user=AUTH_USER&amp;auth_token=AUTH_TOKEN</a></p>\n<p>it will delete ticket id 25, if it is present and current user has permission to delele this ticket. </p>\n","urlObject":{"protocol":"https","path":["wp-json","supportcandy","v1","deleteTickets","{id}"],"host":["yourdomain","com"],"query":[{"description":{"content":"<p>(Required) auth_user you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_user","value":"AUTH_USER"},{"description":{"content":"<p>(Required) auth_token you get from \"/login\" route.</p>\n","type":"text/plain"},"key":"auth_token","value":"AUTH_TOKEN"}],"variable":[]}},"response":[],"_postman_id":"359abd71-3bfa-48e7-92ee-d8888f06b05f"}]}