fastify-xhubspot
deals.delete
Archive (soft-delete) a HubSpot deal by ID.
deals.delete
Archive a HubSpot deal.
Signature
fastify.deals.delete(dealId: string): Promise<true>
Params
| Name | Type | Required | Description |
|---|---|---|---|
dealId | string | Yes | HubSpot internal deal ID to archive. |
Returns
true on success.
Throws
[xHubspot] deals.delete requires a dealId- Re-throws HubSpot API errors.
Examples
await fastify.deals.delete("67890");
fastify.delete("/deals/:id", async (request, reply) => {
await fastify.deals.delete(request.params.id);
return reply.code(204).send();
});
See also
- deals.create — create a deal
- deals.getById — verify before deleting
AI Context
package: "@xenterprises/fastify-xhubspot"
method: fastify.deals.delete(dealId)
use-when: Archive a HubSpot deal
returns: void
