Delete

Basic

This method interacts with the Basic Delete endpoint to delete a resource by its unique identifier.

Usage

const response = await userService.delete('79c8c567b05e986509d55733a');

Parameters

Parameter	Type	Description
identifier	string	Unique identifier of the resource to be deleted.
axiosRequestConfig	AxiosRequestConfig (optional)	Axios request configuration for fine-tuning the HTTP request.

Response

Prop	Type	Description
success	boolean	Indicates whether the request was successful.
status	number	HTTP status code of the response.
message	string	A message providing additional information about the response, especially in case of errors.
raw	string	The ID of the deleted resource.
data	string	The ID of the deleted resource.
headers	object[AxiosHeaders]	Axios headers associated with the response.

200

{
  success: true,
  status: 200,
  raw: '79c8c567b05e986509d55733a',
  data: '79c8c567b05e986509d55733a',
  headers: Object [AxiosHeaders] {}
}

401

{
  success: false,
  status: 401,
  message: 'Unauthorized',
  headers: Object [AxiosHeaders] {}
}

403

{
  success: false,
  status: 403,
  message: 'Forbidden',
  headers: Object [AxiosHeaders] {}
}

404

{
  success: false,
  status: 403,
  message: 'Not Found',
  headers: Object [AxiosHeaders] {}
}