DELETE Request


The DELETE verb allows you to delete a single User.  Our platform will immediately remove the User from the platform.

You may use either JSON or XML formats in your request.


You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml". If no ContentType is specified, XML format is assumed.

The required and optional parameters for a DELETE to the User API are outlined below.

Parameter Name
Data Type
Required
Description
User
User
Yes
The User that you wish to create.  See the User type definition from the GET above.

 User (<User>) Required Fields
The following fields must be specified when issuing a DELETE request to the User API.
All other fields will be ignored.

Field Name
Data Type
Description
IntegrationKey
String
Your unique Integration Key found on the Organization Setup page of the secure website (under My Account)
CompanyId
Integer
Your unique Provider Id found on the Organization Setup page of the secure website (under My Account)
Id
GUID
Unique identifier of the User.  You would have received this when creating the User via POST.

 

DELETE Response

If the DELETE update is successful, a 200 HTTP status is returned along a UserResponse.
If the DELETE is unsuccessful, a 400 HTTP status is returned along with a UserResponse.

User Response (<UserResponse>)

Field Name
Data Type
Description
ResponseStatus
ResponseStatus
Details of any errors that may have occurred