Skip to main content
DELETE
Cancel a one-off task
Withdraws a one-off task. The task is kept with state cancelled, so reports and the timeline still show that it existed and was dropped.

Example

The JSON body is required. Some HTTP clients drop the body of a DELETE unless you send it explicitly.

Good to know

  • Tasks from a sequence are refused with 422. Skip them, or remove the prospect from the sequence.
  • Cancelling a task that is already resolved returns 409, so a repeated request is a 409 rather than a second cancellation.
  • A call task is removed from the dial list.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

24-character task id.

Body

application/json
user_id
string
required

The team member this call acts as. Must be an active member of the team the API key belongs to.

Example:

"507f1f77bcf86cd799439011"

Response

The task was cancelled.

deleted
enum<boolean>
required

Always true.

Available options:
true