Sign in

v1

latestOpenAPI 3.1.02026-07-223614164.6 KB
Deals

Delete a deal

Delete an existing deal in the workspace.

delete/v1/groups/{groupId}/{objectType}/{objectId}

Path parameters

groupIdstring required

The ID of the group the deals belong to. Can be retrieved from the List groups endpoint.

objectTypestring required

The name of a deal custom field that can be retrieved from the List group custom fields endpoint.

objectIdstring required

The ID of the deal to delete.

Response

The ID of the deleted deal.

deprecationsstring[]

Example response

{
  "data": {
    "id": "obj_183ed5cc-3182-45de-84d1-d520f2604810"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}