DELETE
/api/public/v1/deals/{dealId}

Archive a deal

Archives rather than removes — a lost pipeline is still history worth keeping. Pass `includeArchived=true` on the list to see it again.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

deals:write

Path Parameters

NameTypeRequiredDescription
dealIdstringRequiredDeal ID.
DELETEExample request
curl
curl -X DELETE "https://www.pxb.app/api/public/v1/deals/{dealId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Deal archived successfully!",
  "content": {
    "dealId": "del_8830"
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Pipeline
/xrm/pipeline
  1. Open the ⋯ menu on a deal → Archive.