The DELETE User API allows you to delete an existing user.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/user?format=xml/json
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/user | Model Description/Schema & Parameters |
Parameters
The DELETE verb on the User API allows you to delete an existing user. The required and optional parameters for a DELETE call to the User API are outlined below:
| Name | Type | Description | Required |
|---|---|---|---|
| Id | String | The User’s unique identifier (GUID). Can be obtained from the User Search API. | ✓ |
| CompanyId | Integer | Your unique Company Id found on the Organisation Setup page of the secure website. | ✓ |
| IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
Example
Given that the API is REST-based, you can access the API directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.
Request URL
https://eforms.mobileform.net/api/v2/user?Id=61423b5b432f4121XXXXXXX&CompanyId=XXXXX&IntegrationKey=78eec3032af240XXXXXXXBelow is an unpopulated code block of what a typical DELETE request JSON body to the User API might look like.
Request Body
{
"Id": "",
"CompanyId": "",
"IntegrationKey": ""
}