Skip to main content
POST
Delete deals in batch
This action is not reversible. When removing a deal from the workspace, all of its information is deleted, including its custom field values, notes, and any associations with groups, companies, and other entities.
Each deal is deleted on its own, and the response gives the outcome of every record. See batch requests for the 100-record limit and how to read the response. A batch targets one object type in one group, given by the path: a record that is not a deal of that type in that group fails as not found. If the API key cannot delete deals in the group, every record fails. A deal designated by several records is deleted once, and each of those records reports it as deleted.

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

Body

application/json
records
object[]
required
Maximum array length: 100

Response

The outcome of each record, with the ID of each deleted deal.

data
object
required
Example:
deprecations
string[]
Example: