Delete a user

Removes a user account for good, the way the console's Users grid does.

Reference

DELETE https://YOUR-NETWORK-DOMAIN/rest-api/system-users/{userId}/delete.do

Removes a user account for good, the way the console's Users grid does. The caller needs the DELETE permission on the target's role: at All level it may delete any user of that role, at Shared level only the users it owns (the statistics accounts it created). A user whose role was deleted takes MANAGE_ROLE on some role instead - and, if it was an administrator, an administrator - and a caller cannot delete their own account. This is not a soft delete and cannot be undone: the account and everything that hangs off it go with it - its advertiser, site, action and template shares (so an advertiser or site it was the owner of is left without one), its saved reports and their schedules, its dashboard widgets, notification settings and notifications, its scheduled events, payment details, limits, API-key and IP whitelist rows, and its action-log history. The advertisers, campaigns, sites and placements themselves are not touched, and neither is the traffic they have served. Accounts the deleted user owned are left without an owner, not deleted. The deletion is written to the action log, and the user is gone from /rest-api/system-users/search.do afterwards.

Path Params

userId integer required

Numeric id of the user to delete, as /rest-api/system-users/search.do reports it

42

Responses

200

{success, deletedUserId, username}

400

userId is the caller's own account

401

Unauthorized - authentication error

403

The caller lacks DELETE on the target's role (or MANAGE_ROLE for a user whose role was deleted); the message names it

404

No user with this id

Language

cURL Request

curl --request DELETE \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("DELETE"), "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/delete.do")
request = Net::HTTP::Delete.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body