DiamanteDesk REST APIs enable interaction between the application and other software products, such as websites, CRMs, content management systems and other applications. Using the DiamanteDesk REST APIs you can read, modify, add and delete the data directly in the helpdesk.

To ensure secure access it is recommended to use HTTPS protocol for API requests.

API Endpoints

API endpoints define the connection point to your service, giving the external application access to DiamanteDesk data. API endpoints are prefixed with your domain name:

http(s)://domainname/rest/api/{version}/desk/

Authentication

DiamanteDesk uses WSSE authentication to ensure secure access to the third party applications via REST APIs. WSSE authentication in DiamanteDesk application, which is based on Symfony, is implemented by using this bundle.

WSSE authentication is based on:

  • a username;
  • a nonce (created to avoid replay attacks);
  • a timestamp;
  • the password digest (In DiamanteDesk the password digest is represented as API Key. To learn how to generate API key, please check the API Credentials article in the Integration section of DiamanteDesk documentation).

Format

All the data in DiamanteDesk APIs is transmitted either in JSON or XML format with JSON being a default format. The format can be specified either:

  • in the request header (Content-Type, Accept). Note: The MIME type shall be specified in header (application/json, application/xml).
  • or specified in the URL.

Pagination, Sorting, Filtering

Pagination

When a user performs a request to get a collection of entities or a certain entity, the data requested is returned in the response body. Depending on the requested items, objects or products, the list of results can contain thousands of results that should be paged through. The number of items per each page can be specified using page parameters. Paginated queries start at page 1 by default.

For example, if you set the page limit to 10 items and you need to retrieve items from 21 to 30 your request should contain such parameters: limit=10 and page=3.

When a user requests a list of certain entities, the server returns the results along with additional metadata, such as:

  • the general amount of entities, shown at the X-Total HTTP header;
  • the links to the connected pages in the Link HTTP header. There are 4 types of such links:
Name Description
next The URL to the following results page.
last The URL to the last results page.
first The URL to the first results page.
prev The URL to the previous results page.

Take a look at the example, containing such headers:

HTTP/1.1 200 OK

Link: <http://hostname/api/rest/latest/desk/branches?limit=25&page=2>; rel="next", <http://hostname/api/rest/latest/desk/branches?limit=25&page=5>; rel="last"
X-Total: 110

Sorting

The results can be sorted according to the sort and order GET parameters, included in the URL. The sort parameter performs the sorting according to the property name of an entity, order parameter may be set either to asc (ascending) or desc (descending).

Filtering

Filtering can be performed according to any parameter of the corresponding entity. For example, to filter the branch by its key, add “key=PO” parameter to the URL.

If the value is specified for string property, the search is performed for any occurrence, meaning the result will return PO, DPO, DPOD, etc. If the value is specified for numeric property the search is performed for equal value.

To filter the results by the time when a certain entity or entities were created or updated, the following parameters should be used:

  • createdBefore
  • createdAfter
  • updatedBefore
  • updatedAfter

Error Handling

When the fault occurs within the application or on a server side, the server returns the corresponding status code followed by the message, indicating the root cause in the response body.

Here are the status codes of the errors that may occur when working with DiamanteDesk application.

Status Code Description
400 Validation failed and the request provided by the client was incorrect or distorted and the server could not understand it.
401 Such error occurs when a user attempts to access a page or resource that requires authentication. To resolve this issue, correct log in details shall be provided.
403 Authorization issue, meaning that a user has not been granted permission to access specific page or method.
404 This error means that the server could not process client request with the reason for that described in the error message.
500 Internal server error. This status code indicates that this is not a client-side issue, meaning that the problem occurred on the server side rather than in DiamanteDesk application.

Take a look at the example of a 404 error below:

POST /diamantedesk-1.0/web/api/rest/latest/desk/branches HTTP/1.1

{
    "name": "Test Branch",
    "description": "Test Description",
    "tags": [
        "Test Tag",
        "TB1"
    ],
    "key": "BRANCHTEST"
}

HTTP/1.1 404 Not Found

{
    "error": "Branch key already exists. Please, provide another one."
}

Resources

REST APIs are necessary when DiamanteDesk is integrated into another application and when interactions with the DiamanteDesk server shall be scripted.

Note: Here are the values of the variables API methods:

Variable Requirements
{version} latest, v1
{_format} xml, json

Branches

GET: Retrieve the list of all branches
GET /api/rest/{version}/desk/branches

Response

Status Code: 200 (OK)

Response body:

[
    {
        "created_at": "2015-07-17T11:25:21+0000",
        "description": "branchDescription1",
        "id": 1,
        "key": "BRANCHB",
        "name": "branchName1",
        "updated_at": "2015-07-17T11:25:21+0000"
    },
    {
        "created_at": "2015-07-17T11:25:21+0000",
        "description": "branchDescription2",
        "id": 2,
        "key": "BRANCHC",
        "name": "branchName2",
        "updated_at": "2015-07-17T11:25:21+0000"
    }
]
GET: Retrieve a branch by ID
GET /api/rest/{version}/desk/branches/{id}

Response

Status Code: 200 (OK)

Response body:

{
    "created_at": "2015-07-17T11:25:36+0000",
    "description": "Test Description",
    "id": 11,
    "key": "BRANCHTEST",
    "name": "Test Branch",
    "updated_at": "2015-07-17T11:25:36+0000"
}

Status Code: 404 (Not Found)

Response body:

{
    "error": "Branch loading failed. Branch not found."
}
POST: Create a new branch
POST /api/rest/{version}/desk/branches

Parameters

Name Type Description Note
name string Required. Specify the name of a new branch. Minimum length is 2 letters.
description string Enter the description of a new branch, if necessary.
tags arrey of strings Optional Specify the tags appropriate for the new branch. To learn more about tagging in DiamanteDesk, please check the Tagging section in the User Guide section.
key string Enter the key of a new branch. This key should be unique accross the whole system. The branch key must contain only letters. Minimum length is 2 letters.

Request example:

{
    "name": "Test Branch",
    "description": "Test Description",
    "tags": [
        "Test Tag"
    ],
    "key": "BRANCHTEST"
}

Response

Status Code: 201 (Created)

Response body:

{
    "created_at": "2015-07-17T11:25:36+0000",
    "description": "Test Description",
    "id": 11,
    "key": "BRANCHTEST",
    "name": "Test Branch",
    "tags": [
        "Test Tag"
    ],
    "updated_at": "2015-07-17T11:25:36+0000"
}
PUT, PATCH: Update properties of a certain branch by its ID
PUT|PATCH /api/rest/{version}/desk/branches/{id}

Request example:

{
    "name": "Test Branch PUT",
    "description": "Test Description",
    "tags": [
        "Test Tag"
    ]
}

Response

Status Code: 200 (OK)

Response body:

{
    "created_at": "2015-07-17T11:25:36+0000",
    "description": "Test Description",
    "id": 11,
    "key": "BRANCHTEST",
    "name": "Test Branch PUT",
    "tags": [
        "Test Tag"
    ],
    "updated_at": "2015-07-17T11:25:36+0000"
}
DELETE: Delete a branch by ID
DELETE /api/rest/{version}/desk/branches/{id}

Response

Status Code: 204 (No Content)

Response body: null

Tickets

GET: Retrieve list of all tickets
GET /api/rest/{version}/desk/tickets

Response

Status Code: 200 (OK)

Response body:

{
    "branch": 1,
    "created_at": "2015-08-20T17:05:07+0000",
    "id": 13,
    "key": "BRANCH-13",
    "priority": "low",
    "reporter": "oro_1",
    "source": "web",
    "status": "new",
    "subject": "test subject",
    "tags": [
      {
        "id": 1,
        "name": "test-tag"
      },
      {
        "id": 2,
        "name": "test-tag2"
      }
    ],
    "unique_id": {
      "id": "52429dbc757cbe09a73f8e841b7d5af5"
    },
    "updated_at": "2015-08-20T19:42:04+0000",
    "watcher_list": [
      {
        "id": 4,
        "user_type": "oro_1"
      }
    ]
  }
GET: Retrieve the ticket by the given ticket ID
GET /api/rest/{version}/desk/tickets/{id}

Response

Status Code: 200 (OK)

Response body:

{
  "attachments": [],
  "branch": 1,
  "comments": [],
  "created_at": "2015-08-20T17:05:07+0000",
  "description": "<p>description</p>",
  "id": 13,
  "key": "BRANCH-13",
  "priority": "low",
  "reporter": "oro_1",
  "source": "web",
  "status": "new",
  "subject": "test subject",
  "tags": [
    {
      "id": 1,
      "name": "test-tag"
    },
    {
      "id": 2,
      "name": "test-tag2"
    }
  ],
  "unique_id": {
    "id": "52429dbc757cbe09a73f8e841b7d5af5"
  },
  "updated_at": "2015-08-20T19:42:04+0000",
  "watcher_list": [
    {
      "id": 4,
      "user_type": "oro_1"
    }
  ]
}

Status Code: 404 (OK)

Response body:

{
    "error": "Ticket loading failed, ticket not found."
}
POST: Create a new ticket
POST /api/rest/{version}/desk/tickets

Parameters

Name Type Description Note
branch integer Required. Specify a branch name where the ticket should be created.
subject string Required. Enter a short description of a new ticket.
description string Required. Enter the detailed description of a new ticket.
status string Required. The available statuses are: New, Open, Pending, In progress, Closed and On Hold.
priority string Required. Specify the priority of a new ticket. The available options are Low, Medium or High.
source string Required. Every service user has 4 available options to contact the Help Desk team: by creating a request through a Web form or through the embedded form on a website (optional), as an Email notification, via a Phone call. Specify the corresponding source of a ticket.
reporter string Required. The reporter is an administrator who can create a ticket for any customer. The name of a reporter must contain only letters.
assignee integer Optional. Select a person responsible for ticket handling. Only OroCRM user can be selected.
tags array of strings Optional. Specify the tags appropriate for the new branch. To learn more about tagging in DiamanteDesk, please check the Tagging section in the User Guide section.

Request example:

{
    "branch": 1,
    "subject": "Test Ticket from API",
    "description": "Test Description",
    "status": "open",
    "priority": "medium",
    "source": "phone",
    "reporter": "oro_1",
    "assignee": 1,
    "tags" : ["test1","test2","test3","test4"]
}

Response

Status Code: 201 (Created)

Response body:

{
  "attachments": [],
  "branch": 1,
  "comments": [],
  "created_at": "2015-07-31T11:26:51+0000",
  "description": "Test Description",
  "id": 95,
  "key": "BRANCHB-10",
  "priority": "medium",
  "reporter": "oro_1",
  "asignee": 1,
  "source": "phone",
  "status": "open",
  "subject": "Test Ticket from API",
  "tags": [
    "test1",
    "test2",
    "test3",
    "test4"
  ],
  "unique_id": {
    "id": "acee0fb73b9c1188472787b20a2760ae"
  },
  "updated_at": "2015-07-31T11:26:51+0000",
  "watcher_list": []
}
PUT, PATCH: Update certain properties of the ticket by ID
PUT, PATCH /api/rest/{version}/desk/tickets/{id}

Request example:

{
   "subject": "New test subject",
   "tags": ["new test tag1", "new test tag2"]
}

Response

Status Code: 200 (OK)

Response body:

{
  "attachments": [],
  "branch": 1,
  "comments": [],
  "created_at": "2015-07-31T11:26:51+0000",
  "description": "Test Description",
  "id": 95,
  "key": "BRANCHB-10",
  "priority": "medium",
  "reporter": "oro_1",
  "source": "phone",
  "status": "open",
  "subject": "New test subject",
  "tags": [
    "new test tag1",
    "new test tag2"
  ],
  "unique_id": {
    "id": "acee0fb73b9c1188472787b20a2760ae"
  },
  "updated_at": "2015-07-31T11:26:51+0000",
  "watcher_list": [
    {
      "id": 23,
      "user_type": "oro_1"
    }
  ]
}
DELETE: Delete the ticket by ID
DELETE /api/rest/{version}/desk/tickets/{id}

Response

Status Code: 204 (No Content)

Response body: null

GET: Retrieve a ticket by the given ticket key
GET /api/rest/{version}/desk/tickets/{key}

Response

Status Code: 200 (OK)

Response body:

{
  "attachments": [],
  "branch": 1,
  "comments": [],
  "created_at": "2015-08-20T17:05:07+0000",
  "description": "<p>test description</p>",
  "id": 13,
  "key": "BRANCH-13",
  "priority": "low",
  "reporter": "oro_1",
  "source": "web",
  "status": "new",
  "subject": "test subject",
  "tags": [
    {
      "id": 1,
      "name": "test-tag1"
    },
    {
      "id": 2,
      "name": "test-tag2"
    }
  ],
  "unique_id": {
    "id": "52429dbc757cbe09a73f8e841b7d5af5"
  },
  "updated_at": "2015-08-20T19:42:04+0000",
  "watcher_list": [
    {
      "id": 4,
      "user_type": "oro_1"
    }
  ]
}

Status Code: 404 (Not Found)

Response body:

}
    "error": "Ticket loading failed, ticket not found."
}
PUT, PATCH: Update certain properties of a ticket by the ticket key
PUT, PATCH /api/rest/{version}/desk/tickets/{key}

Request example:

{
   "subject": "New test subject",
   "tags": ["new test tag5", "new test tag6"]
}

Response

Status Code: 200 (OK)

Response body:

{
  "attachments": [],
  "branch": 1,
  "comments": [],
  "created_at": "2015-07-31T11:26:51+0000",
  "description": "Test Description",
  "id": 95,
  "key": "BRANCHB-10",
  "priority": "medium",
  "reporter": "oro_1",
  "source": "phone",
  "status": "open",
  "subject": "New test subject",
  "tags": [
    "new test tag5",
    "new test tag6"
  ],
  "unique_id": {
    "id": "acee0fb73b9c1188472787b20a2760ae"
  },
  "updated_at": "2015-07-31T11:26:51+0000",
  "watcher_list": [
    {
      "id": 23,
      "user_type": "oro_1"
    }
  ]
}
DELETE: Delete the ticket by the ticket key
DELETE /api/rest/{version}/desk/tickets/{key}

Response

Status Code: 204 (No Content)

Response body: null

GET: Retrieve the list of ticket attachments by ticket ID
GET /api/rest/{version}/desk/tickets/{id}/attachments

Response

Status Code: 200 (OK)

Response body:

[
    {
        "id": 15,
        "created_at": "2015-07-17T11:25:53+0000",
        "updated_at": "2015-07-17T11:25:53+0000",
        "file": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/file\/450385ca08c7cfe5b507ad85f3a17428",
            "filename": "test.jpg"
        },
        "thumbnails": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/thumbnail\/450385ca08c7cfe5b507ad85f3a17428",
            "filename": "450385ca08c7cfe5b507ad85f3a17428.png"
        }
    }
]
GET: Retrieve ticket attachments by attachment ID
GET /api/rest/{version}/desk/tickets/{ticketId}/attachments/{attachmentId}

Response

Status Code: 200 (OK)

Response body:

{
    "id": 15,
    "created_at": "2015-07-17T11:25:53+0000",
    "updated_at": "2015-07-17T11:25:53+0000",
    "file": {
        "url": "http:\/\/localhost\/desk\/attachments\/download\/file\/450385ca08c7cfe5b507ad85f3a17428",
        "filename": "test.jpg"
    },
    "thumbnails": {
        "url": "http:\/\/localhost\/desk\/attachments\/download\/thumbnail\/450385ca08c7cfe5b507ad85f3a17428",
        "filename": "450385ca08c7cfe5b507ad85f3a17428.png"
    }
}

Status Code: 404 (Not Found)

Response body:

{
    "error": "Attachment loading failed. Ticket has no such attachment."
}
POST: Add attachment to the ticket
POST /api/rest/{version}/desk/tickets/{ticketId}/attachments

Request example:

{
    "attachmentsInput": [
        {
            "filename": "test.jpg",
            "content": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="
        }
    ]
}

Response

Status Code: 201 (Created)

Response body:

[
    {
        "id": 15,
        "created_at": "2015-07-17T11:25:53+0000",
        "updated_at": "2015-07-17T11:25:53+0000",
        "file": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/file\/450385ca08c7cfe5b507ad85f3a17428",
            "filename": "test.jpg"
        },
        "thumbnails": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/thumbnail\/450385ca08c7cfe5b507ad85f3a17428",
            "filename": "450385ca08c7cfe5b507ad85f3a17428.png"
        }
    }
]
DELETE: Remove Attachment from the ticket
DELETE /api/rest/{version}/desk/tickets/{ticketId}/attachments/{attachmentId}

Response

Status Code: 204 (No Content)

Response body: null

GET: Retrieve personal data based on the provided ticket ID
GET /api/rest/{version}/desk/ticket/{id}/assignee

Response

Status Code: 200 (OK)

Response body:

{
  "email": "pol.vova@gmail.com",
  "name": "asdasd dasdasd",
  "id": "oro_1"
}

Comments

GET: Retrieve the list of all comments
GET /api/rest/{version}/desk/comments

Response

Status Code: 200 (OK)

Response body:

[
    {
        "attachments": [

        ],
        "author": {
            "email": "emailaddress@server.com",
            "name": "Author Name",
            "id": "diamante_1"
        },
        "content": "commentContent1-1",
        "created_at": "2015-07-17T11:25:22+0000",
        "id": 1,
        "private": false,
        "ticket": 1,
        "updated_at": "2015-07-17T11:25:22+0000"
    },
    {
        "attachments": [

        ],
        "author": {
            "email": "emailaddress@server.com",
            "name": "Author Name",
            "id": "diamante_1"
        },
        "content": "commentContent1-2",
        "created_at": "2015-07-17T11:25:22+0000",
        "id": 2,
        "private": false,
        "ticket": 1,
        "updated_at": "2015-07-17T11:25:22+0000"
    }
]
GET: Retrieve the comment by the given comment ID
GET /api/rest/{version}/desk/comments/{id}

Response

Status Code: 200 (OK)

Response body:

{
    "attachments": [

    ],
    "author": {
        "email": "emailaddress@server.com",
        "name": "Author Name",
        "id": "diamante_1"
    },
    "content": "Test Comment",
    "created_at": "2015-07-17T11:25:22+0000",
    "id": 101,
    "private": false,
    "ticket": 1,
    "updated_at": "2015-07-17T11:25:22+0000"
}

Status Code: 404 (OK)

Response body:

{
    "error": "Comment loading failed, comment not found."
}
POST: Add a new comment to the ticket.
POST /api/rest/{version}/desk/comments

Parameters

Name Type Description Note
content string Required. Add your comment into this section.
ticket integer Required. Provide the ID of a ticket where the comment is added.
author string Required. Specify the name of a user who adds the comment to the ticket. The name of an author must contain only letters.
ticketStatus string Required. Specify the status of a ticket after the new comment is added to it. The available statuses are: New, Open, Pending, In progress, Closed and On Hold.

Request example:

{
    "content": "Test Comment",
    "ticket": 1,
    "author": "oro_1",
    "ticketStatus": "new"
}

Response

Status Code: 201 (Created)

Response body:

{
    "attachments": [

    ],
    "author": {
        "email": "emailaddress@server.com",
        "name": "Author Name",
        "id": "oro_1"
    },
    "content": "Test Comment",
    "created_at": "2015-07-17T11:25:42+0000",
    "id": 104,
    "private": false,
    "ticket": 1,
    "updated_at": "2015-07-17T11:25:42+0000"
}
PUT, PATCH: Update certain properties of the comment be the comment ID
PUT|PATCH /api/rest/{version}/desk/comments/{id}

Response

Status Code: 200 (OK)

Request example:

{
    "content": "Test Comment Updated PUT",
    "ticketStatus": "closed"
}

Response body:

{
    "attachments": [

    ],
    "author": {
        "email": "emailaddress@server.com",
        "name": "Author Name",
        "id": "diamante_1"
    },
    "content": "Test Comment Updated PUT",
    "created_at": "2015-07-17T11:25:22+0000",
    "id": 101,
    "private": false,
    "ticket": 1,
    "updated_at": "2015-07-17T11:25:22+0000"
}
DELETE: Delete a ticket comment by the comment ID
DELETE /api/rest/{version}/desk/comments/{id}

Response

Status Code: 204 (No Content)

Response body: null

GET: Retrieve the information about the comment author based on the provided comment ID
GET /api/rest/{version}/desk/comment/{id}/author

Response

Status Code: 200 (OK)

Response body:

{
  "email": "pol.vova@gmail.com",
  "name": "asdasd dasdasd",
  "id": "oro_1"
}
GET: Retrieve all comment attachments
GET /api/rest/{version}/desk/comments/{id}/attachments

Response

Status Code: 200 (OK)

Response body:

[
    {
        "id": 12,
        "created_at": "2015-07-17T11:25:27+0000",
        "updated_at": "2015-07-17T11:25:27+0000",
        "file": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/file\/61fcb86ab5a53db412b2f3823f8a20ac",
            "filename": "test.jpg"
        },
        "thumbnails": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/thumbnail\/61fcb86ab5a53db412b2f3823f8a20ac",
            "filename": "61fcb86ab5a53db412b2f3823f8a20ac.png"
        }
    }
]
Retrieve comment attachments by the attachment ID
GET /api/rest/{version}/desk/comments/{commentId}/attachments/{attachmentId}

Response

Status Code: 200 (OK)

Response body:

{
    "id": 12,
    "created_at": "2015-07-17T11:25:27+0000",
    "updated_at": "2015-07-17T11:25:27+0000",
    "file": {
        "url": "http:\/\/localhost\/desk\/attachments\/download\/file\/61fcb86ab5a53db412b2f3823f8a20ac",
        "filename": "test.jpg"
    },
    "thumbnails": {
        "url": "http:\/\/localhost\/desk\/attachments\/download\/thumbnail\/61fcb86ab5a53db412b2f3823f8a20ac",
        "filename": "61fcb86ab5a53db412b2f3823f8a20ac.png"
    }
}

Status Code: 404 (OK)

Response body:

{
    "error": "Attachment loading failed. Comment has no such attachment."
}
POST: Add attachment to the comment
POST /api/rest/{version}/desk/comments/{commentId}/attachments

Request example:

{
    "attachmentsInput": [
        {
            "filename": "test.jpg",
            "content": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="
        }
    ]
}

Response

Status Code: 201 (Created)

Response body:

[
    {
        "id": 13,
        "created_at": "2015-07-17T11:25:34+0000",
        "updated_at": "2015-07-17T11:25:34+0000",
        "file": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/file\/338477dbcd9c4faae7584cda781be854",
            "filename": "test.jpg"
        },
        "thumbnails": {
            "url": "http:\/\/localhost\/desk\/attachments\/download\/thumbnail\/338477dbcd9c4faae7584cda781be854",
            "filename": "338477dbcd9c4faae7584cda781be854.png"
        }
    }
]
DELETE: Remove the attachment from the comment by the attachment ID
DELETE /api/rest/{version}/desk/comments/{commentId}/attachments/{attachmentId}

Response

Status Code: 204 (No Content)

Response body: null

Users

GET: Retrieve the list of all users
GET /api/rest/{version}/desk/users

Response

Status Code: 200 (OK)

Response body:

[
    {
        "id": 1,
        "email": "sdasdasd@asfasf.com",
        "first_name": "das",
        "last_name": "dasda"
    },
    {
        "id": 2,
        "email": "vladimir.polischuk@eltrino.com",
        "first_name": "\u0444\u0456\u0432\u0444\u0456\u0432",
        "last_name": "\u0432\u0444\u0456\u0432"
    }
POST: Create a new user
POST /api/rest/{version}/desk/users

Parameters

Name Type Description
firstName string Required. Provide the first name of a new user.
lastName string Required. Provide the last name of a new user.
email string Required. Add an email of a new user. This email is going to be used for email notifications and password recovery.

Request example:

{
    "email": "1437135532dummy-test-email-address@test-server.local",
    "firstName": "John",
    "lastName": "Dou"
}

Response

Status Code: 201 (Created)

Response body:

{
    "id": 11,
    "email": "1437135532dummy-test-email-address@test-server.local",
    "first_name": "John",
    "last_name": "Dou"
}
GET: Retrieve user data
GET /api/rest/{version}/desk/users/{email}/

Response

Status Code: 200 (OK)

Response body:

{
    "id": 11,
    "email": "1437135532dummy-test-email-address@test-server.local",
    "first_name": "John",
    "last_name": "Dou"
}

Status Code: 404 (Not Found) Response body:

{
    "error": "User not found."
}
PUT, PATCH: Update properties of a certain user by its ID
PUT|PATCH /api/rest/{version}/desk/users/{id}

Request example:

{
    "email": "1437135532dummy-test-email-address@test-server.local",
    "first_name": "John",
    "last_name": "Second"
}

Response

Status Code: 200 (OK)

Response body:

{
    "id": 11,
    "email": "1437135532dummy-test-email-address@test-server.local",
    "first_name": "John",
    "last_name": "Second"
}
DELETE: Delete the user by id
DELETE /api/rest/{version}/desk/users/{id}

Response

Status Code: 204 (No Content)

Response body: null