Delete Deals

DELETE https://app.alaaqat.com/api/deals/delete-selected

Deletes one or more deals in a single request. Each deal's notes are deleted with it. Your API key needs the deal-delete ability.

{warning} Deleting is permanent. A deleted deal and its notes cannot be restored.

Header

{
    "Accept": "application/json",
    "Content-Type": "application/json"
}

Body

{
    selected_ids: string[]
}
Field Required Validation Description
selected_ids Required An array of deal IDs The _id of every deal to delete.
{
    "selected_ids": [
        "6651a0b1c2d3e4f5a6b7c801",
        "6651a0b1c2d3e4f5a6b7c802"
    ]
}

Send the IDs under selected_ids. Under any other name, nothing is deleted.

An ID that does not match a deal in your account is skipped, and the rest are still deleted.

Response

200 OK

{
    "message": "Entity was deleted successfully.",
    "data": []
}

The response is the same whether every ID matched a deal or some were skipped. To check the result, list your deals again.