URL: v3/api/admin/create-update-department Method: POST Description : Creates or Updates a department Parameters: Parameter Type Optional/Required Description id integer Optional while updating existing department, id is used name string Required Department name type_id integer Required 0 or 1, public = 1, private = 0 outgoing_email_id integer Optional Email id business_hour_id integer Optional Business Hour id […]
Articles Tagged: v3
Get Department Details
URL: v3/api/admin/edit-department/{id} Method: GET Description : Fetches existing department data Parameters: Parameter Type Optional/Required Description id integer Required Department id Success Response : { “success”: true, “data”: { “department”: { “id”: 3, “name”: “Operation”, “type_id”: 1, “department_sign”: “”, “is_default”: 1, “statuses”: [], “form_identifier”: “department_3”, “business_hour”: null, “outgoing_email”: null, “managers”: [ { “id”: 4, “first_name”: “Private”, […]
Delete Department
URL: v3/api/admin/delete-department/{id} Method: DELETE Description : Delete a department. Parameters: Parameter Type Optional/Required Description id integer Required Department id of the department to be deleted. Success Response : { “success”:true, “Message”:”Department deletion request has been processed successfully. Department will be deleted shortly after processing its dependencies.” }
Get Departments List
URL: v3/api/admin/departments-list/ Method: GET Description : Fetches existing departments and provides search support Parameters: Parameter Type Optional/Required Description search_query string Optional String that is required to be searched. limit integer Optional No. of records to be fetched. sort_order string Optional Records to be ordered in asc or desc. sort_field string Optional Department attribute based on […]
Get Department Profile
URL: v3/api/admin/department-profile/{id} Method: GET Description : Gets department profile Parameters: Parameter Type Optional/Required Description id integer Required Department id Success Response : { “success”: true, “data”: { “id”: 14, “name”: “Support”, “size”: 1, “business_hour”: { “id”: 1, “name”: “Default Business-Hours” }, “managers”: [ { “id”: 5, “first_name”: “Dept”, “last_name”: “”, “email”: “dept6@gmail.com”, “profile_pic”: “https://secure.gravatar.com/avatar/12e754487fa27bc9092e65f0eb8cb1fc?s=80&r=g&d=mm”, “full_name”: […]
Get Tickets Count
URL: v3/api/agent/ticket-count Method: GET Description : Gets ticket count for ticket types inbox, closed, deleted, unapproved Parameters: Parameter Type Optional/Required Description dept-id integer Required Department id to get tickets count Success Response : { “success”: true, “data”: { “inbox”: 1, “closed”: 3, “deleted”: 7, “unapproved”: 6 } }
Create Update Agent
URL: v3/api/admin/agent Method: POST Description : Creates or Updates a agent/admin Parameters: Parameter Type Optional/Required Description email string Required Agent’s email user_name string Required Agent’s user_name first_name string Required Agent’s first_name last_name string Optional Agents last_name type_ids array Optional Ticket type ids ext integer Optional Agent’s extension phone_number integer Optional Agent’s phone_number country_code integer Optional […]
Edit Agent/Admin
URL: v3/api/admin/agent/{agent_id} Method: GET Description : Fetches existing agent/admin data based on agent id Parameters: Parameter Type Optional/Required Description agent_id integer Required Agent/Admin id Success Response : { “success”: true, “data”: { “agent”: [ { “id”: 99, “first_name”: “Krishna”, “last_name”: “Vishwakarma”, “user_name”: “krishna”, “location”: “bangalore”, “role”: “agent”, […]
Get Agent/Admin
URL: v3/api/admin/get-agent/{agentId} Method: GET Description : Fetches existing Agent/Admin data Parameters: Parameter Type Optional/Required Description agentId integer Required Agent/Admin id Success Response : { “success”: true, “data”: { “agent”: [ { “id”: 101, “user_name”: “krishna”, “role”: “agent”, “email”: “krishna@faveo.com”, “profile_pic”: “https://secure.gravatar.com/avatar/d15e173f92f94fd80a5ef7773a19b25e?s=80&r=g&d=identicon”, “ext”: “080”, “country_code”: 91, “mobile”: […]
Change Agent/Admin Property
URL: v3/api/admin/change-agent/{agent_id} Method: GET Description : Fetches existing Agent/Admin data to change role, password, active field. Parameters: Parameter Type Optional/Required Description agent_id integer Required Agent/Admin id email string Optional Agent/Admin changed email role string Optional Agent/Admin changed role password String Optional Agent/Admin changed password active integer Optional Agent/Admin activate/deactivate Success Response : { “success”:true, “Message”:”Email […]