Skip to main content
POST
/
api
/
automations
/
{id}
/
run
Run an automation now
curl --request POST \
  --url https://clarus-api.com/api/automations/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "error": "<string>"
}

​
Behavior

Triggers the automation immediately. Primarily used for schedule-based automations (daily_schedule, weekly_schedule, monthly_schedule, one_time_schedule).
  • No request body required
  • The automation’s conditions are still evaluated before its actions run

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the automation to run

Response

Automation triggered successfully