Delete Multiple Users API
Deletes multiple users in a single request by providing an array of user IDs. Available to SUPER_ADMIN, PARTNER, MERCHANT, and BRANCH users.
Overview
Deletes multiple users in a single request using their unique identifiers.
HTTP Method: PATCH
Endpoint: /api/v1/users/batch-delete
Access Levels: SUPER_ADMIN, PARTNER, MERCHANT, BRANCH
Authentication
Include the API key in the request headers.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
Content-Type | application/json |
Production Base URL: https://app-api.edfapay.com
Request Parameters
No path or query parameters are required.
Request Body
The request body is required and must contain a JSON array of user IDs.
| Field | Type | Description |
|---|---|---|
| Request body | Array of UUID strings | List of unique identifiers for the users to delete. |
Example Request
[
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]Replace the example values with the actual user IDs to be deleted.
Responses
200 OK
The request was processed successfully.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}400 Bad Request
The request could not be processed because of invalid or incorrect request data.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Integration Notes
- Provide a JSON array containing valid user IDs.
- Verify the selected IDs before submitting the request.
- The endpoint is documented as a delete operation; confirm the applicable deletion rules and any restrictions before using it in production.
- Handle the response according to the returned HTTP status and response fields.
Note: The API specification does not define whether the operation is transactional, how partially invalid ID lists are handled, or whether deletion is permanent or logical. Confirm these behaviors with the API implementation.
Updated 25 days ago