Customer API V1.0

API change history

deleteUser

The endpoint can be used to send requests to delete user information as is pursuant to GDPR requirements (meaning, an Admin will not be able to recreate these users). Maximum 100 users per request.

Try it

Request

Request URL

Request headers

  • (optional)
    string

    Customer API Key generated in Admin Portal

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Parameter responsible for providing the list of users that will be deleted.

{
  "customerId": 0,
  "users": [
    {
      "userId": 0,
      "email": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "customerId": {
      "format": "int32",
      "description": "Parameter available for BSI or Partner and responsible for specifying customer by ID.",
      "type": "integer"
    },
    "users": {
      "description": "Parameter responsible for providing the list of users that will be deleted. Maximum 100 users per request.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userId": {
            "format": "int32",
            "description": "Parameter responsible for ID of a user being deleted.",
            "type": "integer"
          },
          "email": {
            "description": "Parameter responsible for Email of a user being deleted.",
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "customerId": 0,
  "users": [
    {
      "userId": 0,
      "email": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "customerId": {
      "format": "int32",
      "description": "Parameter available for BSI or Partner and responsible for specifying customer by ID.",
      "type": "integer"
    },
    "users": {
      "description": "Parameter responsible for providing the list of users that will be deleted. Maximum 100 users per request.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userId": {
            "format": "int32",
            "description": "Parameter responsible for ID of a user being deleted.",
            "type": "integer"
          },
          "email": {
            "description": "Parameter responsible for Email of a user being deleted.",
            "type": "string"
          }
        }
      }
    }
  }
}
<UsersDeleteDto>
  <customerId>0</customerId>
  <users>
    <userId>0</userId>
    <email>string</email>
  </users>
</UsersDeleteDto>
{
  "type": "object",
  "properties": {
    "customerId": {
      "format": "int32",
      "description": "Parameter available for BSI or Partner and responsible for specifying customer by ID.",
      "type": "integer"
    },
    "users": {
      "description": "Parameter responsible for providing the list of users that will be deleted. Maximum 100 users per request.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userId": {
            "format": "int32",
            "description": "Parameter responsible for ID of a user being deleted.",
            "type": "integer"
          },
          "email": {
            "description": "Parameter responsible for Email of a user being deleted.",
            "type": "string"
          }
        }
      }
    }
  }
}
<UsersDeleteDto>
  <customerId>0</customerId>
  <users>
    <userId>0</userId>
    <email>string</email>
  </users>
</UsersDeleteDto>
{
  "type": "object",
  "properties": {
    "customerId": {
      "format": "int32",
      "description": "Parameter available for BSI or Partner and responsible for specifying customer by ID.",
      "type": "integer"
    },
    "users": {
      "description": "Parameter responsible for providing the list of users that will be deleted. Maximum 100 users per request.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userId": {
            "format": "int32",
            "description": "Parameter responsible for ID of a user being deleted.",
            "type": "integer"
          },
          "email": {
            "description": "Parameter responsible for Email of a user being deleted.",
            "type": "string"
          }
        }
      }
    }
  }
}

Responses

200 OK

OK

Representations

{}
{
  "type": "object"
}
{}
{
  "type": "object"
}
<UserDeleteDelete200ApplicationXmlResponse />
{
  "type": "object"
}
<UserDeleteDelete200TextXmlResponse />
{
  "type": "object"
}

400 Bad Request

BadRequest

Representations

{}
{
  "type": "object",
  "additionalProperties": {
    "type": "object",
    "properties": {
      "value": {
        "type": "object",
        "properties": {
          "attemptedValue": {
            "type": "string",
            "readOnly": true
          },
          "culture": {
            "type": "string",
            "readOnly": true
          },
          "rawValue": {
            "type": "object",
            "readOnly": true
          }
        }
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "exception": {
              "type": "object",
              "readOnly": true
            },
            "errorMessage": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      }
    }
  }
}
{}
{
  "type": "object",
  "additionalProperties": {
    "type": "object",
    "properties": {
      "value": {
        "type": "object",
        "properties": {
          "attemptedValue": {
            "type": "string",
            "readOnly": true
          },
          "culture": {
            "type": "string",
            "readOnly": true
          },
          "rawValue": {
            "type": "object",
            "readOnly": true
          }
        }
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "exception": {
              "type": "object",
              "readOnly": true
            },
            "errorMessage": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      }
    }
  }
}
<UserDeleteDelete400ApplicationXmlResponse />
{
  "type": "object",
  "additionalProperties": {
    "type": "object",
    "properties": {
      "value": {
        "type": "object",
        "properties": {
          "attemptedValue": {
            "type": "string",
            "readOnly": true
          },
          "culture": {
            "type": "string",
            "readOnly": true
          },
          "rawValue": {
            "type": "object",
            "readOnly": true
          }
        }
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "exception": {
              "type": "object",
              "readOnly": true
            },
            "errorMessage": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      }
    }
  }
}
<UserDeleteDelete400TextXmlResponse />
{
  "type": "object",
  "additionalProperties": {
    "type": "object",
    "properties": {
      "value": {
        "type": "object",
        "properties": {
          "attemptedValue": {
            "type": "string",
            "readOnly": true
          },
          "culture": {
            "type": "string",
            "readOnly": true
          },
          "rawValue": {
            "type": "object",
            "readOnly": true
          }
        }
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "exception": {
              "type": "object",
              "readOnly": true
            },
            "errorMessage": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X DELETE "https://qhapi.quickhelp.com/v1/User/Delete"
-H "Authorization: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://qhapi.quickhelp.com/v1/User/Delete?" + queryString;

            var response = await client.DeleteAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://qhapi.quickhelp.com/v1/User/Delete");


            URI uri = builder.build();
            HttpDelete request = new HttpDelete(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://qhapi.quickhelp.com/v1/User/Delete?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "DELETE",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://qhapi.quickhelp.com/v1/User/Delete";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"DELETE"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://qhapi.quickhelp.com/v1/User/Delete');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_DELETE);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('qhapi.quickhelp.com')
    conn.request("DELETE", "/v1/User/Delete?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('qhapi.quickhelp.com')
    conn.request("DELETE", "/v1/User/Delete?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://qhapi.quickhelp.com/v1/User/Delete')


request = Net::HTTP::Delete.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body