Skip to content

Collaborator remove

Sayar Samanta edited this page Aug 28, 2018 · 2 revisions

Description : To remove collaborator from the ticket in FAVEO.

  1. URL : api/v1/helpdesk/collaborator/remove

Parameters :

Name Data Type Required/Optional Description
token String Required token generated for a user
api_key String Optional An alphanumeric code that can be used to authenticate your API calls
ticket_id String Required id of the ticket
email String Required email of the user

HTTP Method : POST

Response Format : JSON

Response : Remove collaborator from the ticket.In case of any errors, an error message will be returned.

URL Request Example : http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/collaborator/remove?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTYyMDQsImV4cCI6MTUzNTAxNjQ0NCwibmJmIjoxNTM1MDE2MjA0LCJqdGkiOiJJNEM3U1h6emp0d1duMVliIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.NUwY-8WKsVxD9jzslpbvZ8yLCaRWPffvVPeNbh0tFy4&ticketid=113&email=testing@gmail.com

JSON Response Example :

Success Response :

{
    "collaborator": "deleted successfully"
}


Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

If the ticket id is not provided

{
    "error": {
        "ticket_id": [
            "The ticket id field is required."
        ]
    }
}

If the ticket id is not provided and same email id provided again

{
    "error": {
        "email": [
            "The email has already been taken."
        ],
        "ticket_id": [
            "The ticket id field is required."
        ]
    }
}

Installation and Upgrade Guide

Administrator's Guide

Agent's Guide

Email Integration

Release & Upgrade Notes

Known Issues

Contribute & Feedback

Knowledge Base

Third Party Integration

Plugins

API

Clone this wiki locally