Mark a preparation as discarded because the prepared external work will never be sent.

post/actions/{id}/preparations/discard

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/actions/{id}/preparations/discard
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Recommended on every mutating request. A replay with the same key is NOT applied twice: the server answers { ok, idempotent_replay: true, first_seen_at, status } describing the first attempt.

Request body

preparationIdstring
notestring

Response

Transitioned

okboolean
duplicate_preparation_rejectedboolean
action_unchangedobject

Changes

No recorded changes to this operation across all 1 revision of this API.