Reset an approval workflow to the platform default
/approval-workflows/{id}/actions/resetRemoves the organisation's own steps for this type and returns the workflow, from any state to custom: false with no steps, so the platform default applies. It can be repeated and requests in progress are not changed. An unknown type, or user_invite, is 404. dry_run shows the result without saving it. Emits approval_workflow.reset only when steps were removed; no email. Undo it with PUT /approval-workflows/{id}.
Path parameters
- One of:
The workflow type, such as
internal_publish. Workflows are keyed by their type, not a UUID. The types are client_invite, incoming_connect, internal_provider_publish, internal_publish and provider_approval; any other value is 404.client_invite,incoming_connect,internal_provider_publish,internal_publish,provider_approval
Query parameters
Validate and run the call without committing it, returning what the real call would return with
meta.dry_runset.
Headers
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
{
"data": {
"id": "string",
"request_kind": "opportunity",
"custom": true,
"steps": [
{}
],
"created_at": "2026-06-12T10:00:00+00:00",
"updated_at": "2026-06-12T10:00:00+00:00"
}
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
Examples
curl -X POST https://your-org-domain/kong/core/api/v2/approval-workflows/{id}/actions/reset\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"