Skip to main content
POST
Stop a currently-running table action, cancelling its remaining work.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

listId
string
required

Body

application/json

Action to stop

Request body for stopping a currently-running table action.

actionId
string
required

ID (UUID) of the action/column to stop.

actionType
string

Action type (see LIST_ACTION_TYPE_* constants).

companyId
string

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

Response

Action stopped

Generic success response

msg
string

Human-readable success message (typically "Success")