Skip to main content
POST
Execute a task action

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Path Parameters

id
integer
required

The task ID.

Body

application/json
action
enum<string>
required

The action to run. schedule and reschedule require a run time this endpoint does not accept, and delete has no action handler (use DELETE /tasks/{id}), so all three are always rejected with a 400.

Available options:
pause,
reschedule,
unpause,
cancel,
start,
delete,
skip,
complete,
schedule
Example:

"complete"

Response

The action was run.

success
boolean
Example:

true

data
object