Delete bulk import users

Delete bulk import users by id. Multiple ids can be passed in the request body.

POST/appid-{appId}/bulk-import/users/remove

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

idsbulkImportUserId[]required

List of bulk import user ids to be deleted

Responses

200Bulk Import Users deleted successfully

deletedIdsbulkImportUserId[]

List of ids that were successfully deleted

invalidIdsbulkImportUserId[]

List of ids that were invalid

400error code 400

string

401error code 401

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

cdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

Request body

Request

curl -X POST "/appid-{appId}/bulk-import/users/remove" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "fa7a0841-b533-4478-9253-0fde890c576"
  ]
}'

const response = await fetch("/appid-{appId}/bulk-import/users/remove", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "ids": [
    "fa7a0841-b533-4478-9253-0fde890c576"
  ]
})
});

import requests

response = requests.post(
    "/appid-{appId}/bulk-import/users/remove",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "ids": [
    "fa7a0841-b533-4478-9253-0fde890c576"
  ]
},
)

Response

{
  "deletedIds": [
    "fa7a0841-b533-4478-9253-0fde890c576"
  ],
  "invalidIds": []
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"