Skip to main content
DELETE
/
v1
/
groups
/
{groupId}
/
{entityType}
/
{dealId}
Delete a deal
curl --request DELETE \
  --url https://api.folk.app/v1/groups/{groupId}/{entityType}/{dealId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "obj_183ed5cc-3182-45de-84d1-d520f2604810"
  }
}
This action is not reversible. When removing a deal from the workspace, all of their information is deleted, including their custom field values, notes, and any associations with groups, companies, and other entities.

Authorizations

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
groupId
string
required

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

Required string length: 40
​
entityType
string
required

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

Maximum length: 500
​
dealId
string
required

The ID of the deal to delete.

Required string length: 40

Response

The ID of the deleted deal.

​
data
object
required
Example:
{
  "id": "obj_183ed5cc-3182-45de-84d1-d520f2604810"
}
​
deprecations
string[]
Example:
["This field is deprecated"]