Delete a list of users. | Invofox

const url = 'https://api.invofox.com/users?account=28b05b800123456789000000&ids=%5B%2228b05b800123456789000000%22%5D';
const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "result": {
    "valid": [
      {
        "item": {
          "_id": "28b05b800123456789000000",
          "account": "28b05b800123456789000000",
          "creator": "28b05b800123456789000000",
          "name": "John Doe",
          "email": "string",
          "lang": "en",
          "creation": "2024-01-15T09:30:00Z",
          "securityGroups": [
            "28b05b800123456789000000"
          ]
        }
      }
    ],
    "error": [
      {
        "item": {
          "_id": "28b05b800123456789000000",
          "account": "28b05b800123456789000000",
          "creator": "28b05b800123456789000000",
          "name": "John Doe",
          "email": "string",
          "lang": "en",
          "creation": "2024-01-15T09:30:00Z",
          "securityGroups": [
            "28b05b800123456789000000"
          ]
        },
        "reason": "ERR_USER_CANNOT_DELETE_ITSELF"
      }
    ],
    "warning": [
      {
        "item": {
          "_id": "28b05b800123456789000000",
          "account": "28b05b800123456789000000",
          "creator": "28b05b800123456789000000",
          "name": "John Doe",
          "email": "string",
          "lang": "en",
          "creation": "2024-01-15T09:30:00Z",
          "securityGroups": [
            "28b05b800123456789000000"
          ]
        },
        "reason": "WARN_USER_HAS_LOCKED_DOCUMENTS"
      }
    ]
  }
}

Autenticación

x-api-keystring

Autenticación con clave API vía encabezado

Parámetros de consulta

accountstringRequerido

idslist of stringsRequerido

Solicitud

This endpoint expects an object.

previewbooleanOpcional

Whether to preview the changes or not

Respuesta

Preview of the changes.

resultobject

Errores

400

Bad Request Error

500

Internal Server Error