Journey Events

Delete a journey event

DELETE/journey-events/{id}
transactions:writedelete_journey_eventDestructiveIdempotent

Deletes one journey event and returns 204. The investment's amounts are recalculated without it. Unless another of the investor's events still needs them, the step's form and generated document are removed and access to a folder it released is revoked. If the investor would be left on a branch step, that step's event is deleted too. It emits no webhook and sends no email. It can't be undone and has no dry run. To remove the investor's whole position, use DELETE /investments/{id}.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Responses

204

The journey event was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/journey-events/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"