Delete a deal

Delete an existing deal in the workspace.

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

Delete a deal

cURL

curl --request DELETE \
  --url https://api.folk.app/v1/groups/{groupId}/{objectType}/{objectId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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

objectType · string · required

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

Maximum string length: 500

objectId · string · required

The ID of the deal to delete.

Required string length: 40

Response

200

application/json

The ID of the deleted deal.

data · object · required

Show child attributes

Example:

{
  "id": "obj_183ed5cc-3182-45de-84d1-d520f2604810"
}

deprecations · string[]

Example:

["This field is deprecated"]