Skip to main content
PATCH
Update an automation

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

id
string
required

Automation ID

Body

application/json
name
string
Minimum string length: 1
icon
string
color
string
instructions
string
active
boolean
triggerType
enum<string>
Available options:
MANUAL,
SCHEDULE,
DATA_CHANGE
frequency
enum<string>
Available options:
DAILY,
WEEKDAYS,
WEEKLY,
MONTHLY,
QUARTERLY
preferredHour
integer
Required range: 0 <= x <= 23
preferredDayOfWeek
integer | null
Required range: 0 <= x <= 6
preferredDayOfMonth
integer | null
Required range: 1 <= x <= 31
triggerDatabaseConnectionId
string | null
triggerSqlQuery
string
slackChannel
string | null
emailRecipients
string

Response

Automation updated successfully

data
object
required