Delete a list of users.

DELETE

https://api.invofox.com/users

DELETE

/users

1 curl -X DELETE "https://api.invofox.com/users?account=28b05b800123456789000000&ids=28b05b800123456789000000" \
2      -H "x-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

1 {
2   "result": {
3     "valid": [
4       {
5         "item": {
6           "_id": "28b05b800123456789000000",
7           "account": "28b05b800123456789000000",
8           "creator": "28b05b800123456789000000",
9           "name": "John Doe",
10           "email": "string",
11           "lang": "en",
12           "creation": "2024-01-15T09:30:00Z",
13           "securityGroups": [
14             "28b05b800123456789000000"
15           ]
16         }
17       }
18     ],
19     "error": [
20       {
21         "item": {
22           "_id": "28b05b800123456789000000",
23           "account": "28b05b800123456789000000",
24           "creator": "28b05b800123456789000000",
25           "name": "John Doe",
26           "email": "string",
27           "lang": "en",
28           "creation": "2024-01-15T09:30:00Z",
29           "securityGroups": [
30             "28b05b800123456789000000"
31           ]
32         },
33         "reason": "ERR_USER_CANNOT_DELETE_ITSELF"
34       }
35     ],
36     "warning": [
37       {
38         "item": {
39           "_id": "28b05b800123456789000000",
40           "account": "28b05b800123456789000000",
41           "creator": "28b05b800123456789000000",
42           "name": "John Doe",
43           "email": "string",
44           "lang": "en",
45           "creation": "2024-01-15T09:30:00Z",
46           "securityGroups": [
47             "28b05b800123456789000000"
48           ]
49         },
50         "reason": "WARN_USER_HAS_LOCKED_DOCUMENTS"
51       }
52     ]
53   }
54 }

Authentication

x-api-keystring

API Key authentication via header

Query parameters

accountstringRequired

idslist of stringsRequired

Request

This endpoint expects an object.

previewbooleanOptional

Whether to preview the changes or not

Response

Preview of the changes.

resultobject or null

Authentication

Query parameters

Request

Response

Errors