Delete an engagement (DELETE /api/v1/engagements/{id})

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

DELETE

/api/v1/engagements/{id}

DELETE

/api/v1/engagements/{id}

Deletes an engagement together with its entries. Cannot be undone. 409 engagement_invoiced when any period has an advance invoice or invoiced quantity: void those invoices first, or cancel it instead. Only owners and admins may do this (403 forbidden otherwise).

Authorization

bearerAuth

headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Path Parameters

id*string

The engagement's id.

Response Body

Deleted.

Example Request

curl -X DELETE 'https://app.helvetly.com/api/v1/engagements/string'

Example Request

curl -X DELETE 'https://app.helvetly.com/api/v1/engagements/string'

Example Response

Empty

Delete an engagement

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body