Skip to main content
Browse the docs

Archive a completed or cancelled job

DELETE/api/v1/jobs/{id}

Deleting archives the job, which leaves every list. Invoices keep their job_id. An active job returns 409; complete or cancel it first.

  • Needs an API key, and runs with the access of the member who made the key.
  • Send an Idempotency-Key. The same key with the same request within 24 hours gives the first answer again and changes nothing.
  • A connected AI assistant can use it too, as deleteJob.

Parameters

In the address

  • idstring (uuid)required

Headers

  • Idempotency-Keystringrequired

    Unique user-scoped key for safely retrying this mutation for 24 hours.

    At least 1 character. Up to 200 characters.

Request body

Sent as application/json.

  • lock_versioninteger

    At least 0.

Responses

204The operation completed successfully.

No body.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl -X DELETE "https://app.tradesender.co.uk/api/v1/jobs/a61b26e9-1f30-5477-8902-db1d7ecc942a" \
  -H "Authorization: Bearer $TRADESENDER_KEY" \
  -H "Idempotency-Key: $(uuidgen)"