The DELETE verb

allows you to delete a single User.  Our platform will immediately remove the User, so handle with caution.

DELETE Request

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
SUser SUser Yes The User that you wish to delete  See the SUser type definition from the GET above.

SUser (<SUser>) Required Fields

The following fields must be specified when issuing a DELETE request to the SUser API.

All other fields will be ignored.

Field Name Data Type Description
IntegrationKey String Your unique Integration Key found on the Organisation Setup page of the secure website (under Your Account)
ProviderId Integer Your unique Provider Id found on the Organisation Setup page of the secure website (under Your 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 SUserResponse.

If the DELETE is unsuccessful, a 400 HTTP status is returned along with a SUserResponse.

SUser Response (<SUserResponse>)

Field Name Data Type Description
ResponseStatus ResponseStatus Details of any errors that may have occurred.
API FormsFly System. REST Connector. API – DELETE Task. API – PUT User. API – POST Form Entry to External Web Service. API – GET Tasks. API – Form GET Entries. API – Form GET Media File. API – POST Task. API – POST User. API – GET Data Source. API – GET Users. Integration API Overview. API – PUT Data Source. Advanced Integration. Will it connect to our existing systems?. API – DELETE User.