Update an automation
curl --request PATCH \
--url https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": "<string>",
"color": "<string>",
"instructions": "<string>",
"active": true,
"preferredHour": 11,
"preferredDayOfWeek": 3,
"preferredDayOfMonth": 16,
"triggerDatabaseConnectionId": "<string>",
"triggerSqlQuery": "<string>",
"slackChannel": "<string>",
"emailRecipients": "<string>"
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}"
payload = {
"name": "<string>",
"icon": "<string>",
"color": "<string>",
"instructions": "<string>",
"active": True,
"preferredHour": 11,
"preferredDayOfWeek": 3,
"preferredDayOfMonth": 16,
"triggerDatabaseConnectionId": "<string>",
"triggerSqlQuery": "<string>",
"slackChannel": "<string>",
"emailRecipients": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
icon: '<string>',
color: '<string>',
instructions: '<string>',
active: true,
preferredHour: 11,
preferredDayOfWeek: 3,
preferredDayOfMonth: 16,
triggerDatabaseConnectionId: '<string>',
triggerSqlQuery: '<string>',
slackChannel: '<string>',
emailRecipients: '<string>'
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'icon' => '<string>',
'color' => '<string>',
'instructions' => '<string>',
'active' => true,
'preferredHour' => 11,
'preferredDayOfWeek' => 3,
'preferredDayOfMonth' => 16,
'triggerDatabaseConnectionId' => '<string>',
'triggerSqlQuery' => '<string>',
'slackChannel' => '<string>',
'emailRecipients' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"icon\": \"<string>\",\n \"color\": \"<string>\",\n \"instructions\": \"<string>\",\n \"active\": true,\n \"preferredHour\": 11,\n \"preferredDayOfWeek\": 3,\n \"preferredDayOfMonth\": 16,\n \"triggerDatabaseConnectionId\": \"<string>\",\n \"triggerSqlQuery\": \"<string>\",\n \"slackChannel\": \"<string>\",\n \"emailRecipients\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"icon\": \"<string>\",\n \"color\": \"<string>\",\n \"instructions\": \"<string>\",\n \"active\": true,\n \"preferredHour\": 11,\n \"preferredDayOfWeek\": 3,\n \"preferredDayOfMonth\": 16,\n \"triggerDatabaseConnectionId\": \"<string>\",\n \"triggerSqlQuery\": \"<string>\",\n \"slackChannel\": \"<string>\",\n \"emailRecipients\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"icon\": \"<string>\",\n \"color\": \"<string>\",\n \"instructions\": \"<string>\",\n \"active\": true,\n \"preferredHour\": 11,\n \"preferredDayOfWeek\": 3,\n \"preferredDayOfMonth\": 16,\n \"triggerDatabaseConnectionId\": \"<string>\",\n \"triggerSqlQuery\": \"<string>\",\n \"slackChannel\": \"<string>\",\n \"emailRecipients\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"icon": "<string>",
"color": "<string>",
"instructions": "<string>",
"active": true,
"archivedAt": "2023-11-07T05:31:56Z",
"trigger": {
"preferredHour": 11,
"preferredDayOfWeek": 3,
"preferredDayOfMonth": 16,
"databaseConnectionId": "<string>",
"sqlQuery": "<string>"
},
"notifications": {
"slackChannel": "<string>",
"emailRecipients": "<string>"
},
"createdByMemberId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "RateLimitExceeded",
"detail": "<string>",
"retryAfterMs": 123
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}Automations
Update an automation
Updates an automation by ID. Requires admin access to the organization.
PATCH
/
api
/
public
/
organizations
/
{orgId}
/
automations
/
{id}
Update an automation
curl --request PATCH \
--url https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": "<string>",
"color": "<string>",
"instructions": "<string>",
"active": true,
"preferredHour": 11,
"preferredDayOfWeek": 3,
"preferredDayOfMonth": 16,
"triggerDatabaseConnectionId": "<string>",
"triggerSqlQuery": "<string>",
"slackChannel": "<string>",
"emailRecipients": "<string>"
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}"
payload = {
"name": "<string>",
"icon": "<string>",
"color": "<string>",
"instructions": "<string>",
"active": True,
"preferredHour": 11,
"preferredDayOfWeek": 3,
"preferredDayOfMonth": 16,
"triggerDatabaseConnectionId": "<string>",
"triggerSqlQuery": "<string>",
"slackChannel": "<string>",
"emailRecipients": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
icon: '<string>',
color: '<string>',
instructions: '<string>',
active: true,
preferredHour: 11,
preferredDayOfWeek: 3,
preferredDayOfMonth: 16,
triggerDatabaseConnectionId: '<string>',
triggerSqlQuery: '<string>',
slackChannel: '<string>',
emailRecipients: '<string>'
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'icon' => '<string>',
'color' => '<string>',
'instructions' => '<string>',
'active' => true,
'preferredHour' => 11,
'preferredDayOfWeek' => 3,
'preferredDayOfMonth' => 16,
'triggerDatabaseConnectionId' => '<string>',
'triggerSqlQuery' => '<string>',
'slackChannel' => '<string>',
'emailRecipients' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"icon\": \"<string>\",\n \"color\": \"<string>\",\n \"instructions\": \"<string>\",\n \"active\": true,\n \"preferredHour\": 11,\n \"preferredDayOfWeek\": 3,\n \"preferredDayOfMonth\": 16,\n \"triggerDatabaseConnectionId\": \"<string>\",\n \"triggerSqlQuery\": \"<string>\",\n \"slackChannel\": \"<string>\",\n \"emailRecipients\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"icon\": \"<string>\",\n \"color\": \"<string>\",\n \"instructions\": \"<string>\",\n \"active\": true,\n \"preferredHour\": 11,\n \"preferredDayOfWeek\": 3,\n \"preferredDayOfMonth\": 16,\n \"triggerDatabaseConnectionId\": \"<string>\",\n \"triggerSqlQuery\": \"<string>\",\n \"slackChannel\": \"<string>\",\n \"emailRecipients\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"icon\": \"<string>\",\n \"color\": \"<string>\",\n \"instructions\": \"<string>\",\n \"active\": true,\n \"preferredHour\": 11,\n \"preferredDayOfWeek\": 3,\n \"preferredDayOfMonth\": 16,\n \"triggerDatabaseConnectionId\": \"<string>\",\n \"triggerSqlQuery\": \"<string>\",\n \"slackChannel\": \"<string>\",\n \"emailRecipients\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"icon": "<string>",
"color": "<string>",
"instructions": "<string>",
"active": true,
"archivedAt": "2023-11-07T05:31:56Z",
"trigger": {
"preferredHour": 11,
"preferredDayOfWeek": 3,
"preferredDayOfMonth": 16,
"databaseConnectionId": "<string>",
"sqlQuery": "<string>"
},
"notifications": {
"slackChannel": "<string>",
"emailRecipients": "<string>"
},
"createdByMemberId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "RateLimitExceeded",
"detail": "<string>",
"retryAfterMs": 123
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}Authorizations
API key authentication using Bearer token format: Bearer <basedash_api_key>
Body
application/json
Minimum string length:
1Available options:
MANUAL, SCHEDULE, DATA_CHANGE Available options:
DAILY, WEEKDAYS, WEEKLY, MONTHLY, QUARTERLY Required range:
0 <= x <= 23Required range:
0 <= x <= 6Required range:
1 <= x <= 31Response
Automation updated successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I