Skip to main content
DELETE
Delete a deal
Delete an existing object of a given type. Set the objectType path parameter to the name of the object type you want to delete from — Deals, Projects, Applications, or any other object type defined in the group. See Custom objects to find the object types available in a group.
This action is not reversible. When removing an object from the workspace, all of its information is deleted, including its custom field values, notes, and any associations with groups, companies, and other entities.

Authorizations

Authorization
string
header
required

API key for authentication

Headers

Idempotency-Key
string

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

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

The ID of the deleted deal.

data
object
required
Example:
deprecations
string[]
Example: