Delete a user.

DELETE

https://api.invofox.com/users/:id

DELETE

/users/:id

1 const url = 'https://api.invofox.com/users/28b05b800123456789000000?account=28b05b800123456789000000';
2 const options = {
3   method: 'DELETE',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "item": {
3     "_id": "28b05b800123456789000000",
4     "account": "28b05b800123456789000000",
5     "creator": "28b05b800123456789000000",
6     "name": "John Doe",
7     "email": "string",
8     "lang": "en",
9     "creation": "2024-01-15T09:30:00Z",
10     "securityGroups": [
11       "28b05b800123456789000000"
12     ]
13   },
14   "reason": "ERR_USER_ALREADY_DELETED",
15   "type": "error"
16 }

Autenticación

x-api-keystring

Autenticación con clave API vía encabezado

Parámetros de ruta

idstringRequerido

Parámetros de consulta

accountstringRequerido

Solicitud

This endpoint expects an object.

previewbooleanOpcional

Whether to preview the changes or not

Respuesta

Preview of the changes

itemobjectOpcional

reasonenumOpcional

typeenumOpcional

Errores

400

Bad Request Error

404

Not Found Error

500

Internal Server Error