Delete Multiple Partners API
Deletes multiple partner records in a single request using a list of partner UUIDs. This endpoint is available to authorized Super Admin and Partner users.
Overview
The Delete Multiple Partners API allows authorized users to submit multiple partner identifiers in a single request for deletion.
HTTP Method: PATCH
Endpoint: /api/v1/partner/batch-delete
Access Levels: SUPER_ADMIN, PARTNER
Content-Type: application/json
Authentication
Include your API key in the request header:
X-API-KEY: YOUR_API_KEY
Request Body
The request body must contain a JSON array of partner UUIDs.
| Field | Type | Description |
|---|---|---|
| Request body | Array of strings | A list of partner UUIDs to be deleted. |
Example Request Body
[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]Multiple partner identifiers can be provided in the same array.
cURL Example
curl -X PATCH "https://app-api.edfapay.com/api/v1/partner/batch-delete" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: */*" \
-H "Content-Type: application/json" \
-d '[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]'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 input or another request-related error.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Implementation Notes
- Provide partner identifiers as valid UUID strings.
- Ensure the authenticated user has the required access level.
- The API documentation does not specify whether deletion is permanent or whether all submitted records must exist for the operation to succeed.
- Check the response message and error code to determine the result of the request.
Updated 25 days ago