BAbasedash
Automations

Update an automation

Updates an automation by ID. Requires admin access to the organization.

patch/api/public/organizations/{orgId}/automations/{id}

Request

  • Base URL
    https://charts.basedash.com
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Organization ID

idstring required

Automation ID

Request body

namestring
iconstring
colorstring
instructionsstring
activeboolean
triggerType'MANUAL' | 'SCHEDULE' | 'DATA_CHANGE'
frequency'DAILY' | 'WEEKDAYS' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY'
preferredHourinteger
preferredDayOfWeekinteger nullable
preferredDayOfMonthinteger nullable
triggerDatabaseConnectionIdstring nullable
triggerSqlQuerystring
slackChannelstring nullable
emailRecipientsstring

Response

Automation updated successfully

Changes

No recorded changes to this operation across all 1 revision of this API.