Automations
Create Automation
Create a new automation for a project
POST
/
v1
/
automations
Create Automation
curl --request POST \
--url https://api.oviond.com/v1/automations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parent_id": "projAbc123",
"name": "Monthly Report",
"frequency": "monthly",
"day": "1",
"hours": "9",
"minutes": "00",
"timezone": "America/New_York",
"recipients": [
"[email protected]"
],
"template_id": "tmplAbc123",
"sender_id": "sndrAbc123",
"date_text": "Last 30 Days"
}
'import requests
url = "https://api.oviond.com/v1/automations"
payload = {
"parent_id": "projAbc123",
"name": "Monthly Report",
"frequency": "monthly",
"day": "1",
"hours": "9",
"minutes": "00",
"timezone": "America/New_York",
"recipients": ["[email protected]"],
"template_id": "tmplAbc123",
"sender_id": "sndrAbc123",
"date_text": "Last 30 Days"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parent_id: 'projAbc123',
name: 'Monthly Report',
frequency: 'monthly',
day: '1',
hours: '9',
minutes: '00',
timezone: 'America/New_York',
recipients: ['[email protected]'],
template_id: 'tmplAbc123',
sender_id: 'sndrAbc123',
date_text: 'Last 30 Days'
})
};
fetch('https://api.oviond.com/v1/automations', 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://api.oviond.com/v1/automations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parent_id' => 'projAbc123',
'name' => 'Monthly Report',
'frequency' => 'monthly',
'day' => '1',
'hours' => '9',
'minutes' => '00',
'timezone' => 'America/New_York',
'recipients' => [
'[email protected]'
],
'template_id' => 'tmplAbc123',
'sender_id' => 'sndrAbc123',
'date_text' => 'Last 30 Days'
]),
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://api.oviond.com/v1/automations"
payload := strings.NewReader("{\n \"parent_id\": \"projAbc123\",\n \"name\": \"Monthly Report\",\n \"frequency\": \"monthly\",\n \"day\": \"1\",\n \"hours\": \"9\",\n \"minutes\": \"00\",\n \"timezone\": \"America/New_York\",\n \"recipients\": [\n \"[email protected]\"\n ],\n \"template_id\": \"tmplAbc123\",\n \"sender_id\": \"sndrAbc123\",\n \"date_text\": \"Last 30 Days\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.oviond.com/v1/automations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parent_id\": \"projAbc123\",\n \"name\": \"Monthly Report\",\n \"frequency\": \"monthly\",\n \"day\": \"1\",\n \"hours\": \"9\",\n \"minutes\": \"00\",\n \"timezone\": \"America/New_York\",\n \"recipients\": [\n \"[email protected]\"\n ],\n \"template_id\": \"tmplAbc123\",\n \"sender_id\": \"sndrAbc123\",\n \"date_text\": \"Last 30 Days\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.oviond.com/v1/automations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parent_id\": \"projAbc123\",\n \"name\": \"Monthly Report\",\n \"frequency\": \"monthly\",\n \"day\": \"1\",\n \"hours\": \"9\",\n \"minutes\": \"00\",\n \"timezone\": \"America/New_York\",\n \"recipients\": [\n \"[email protected]\"\n ],\n \"template_id\": \"tmplAbc123\",\n \"sender_id\": \"sndrAbc123\",\n \"date_text\": \"Last 30 Days\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"automation_id": "<string>",
"template_id": "<string>"
}
}{
"error": "<string>"
}Authorizations
ApiKeyAuthBearerAuth
Oviond API key (prefix oviond_) sent as a Bearer token — the credential for REST/programmatic and headless integrations. Manage keys in Settings → API Keys. API keys do NOT authenticate the MCP endpoint (/mcp), which uses OAuth 2.1 + PKCE.
Body
application/json
Project ID this automation belongs to
Minimum string length:
1Available options:
daily, weekly, monthly Example:
"weekly"
Example:
"9"
Example:
"00"
Example:
"America/New_York"
Minimum array length:
1Saved email template id, or the literal "custom" to save a new template from the custom payload
Minimum string length:
1Saved email sender id
Minimum string length:
1Available options:
Today, Yesterday, Last 7 Days, Last 30 Days, Last 60 Days, Last Month, This Month, Last 2 Months, Last 3 Months, Last 12 Months, This Year, Last Year Example:
"Last 30 Days"
Example:
"monday"
Available options:
AM, PM Required when template_id === "custom" — saved as a new named email template (name + subject + message)
Show child attributes
Show child attributes
⌘I
Create Automation
curl --request POST \
--url https://api.oviond.com/v1/automations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parent_id": "projAbc123",
"name": "Monthly Report",
"frequency": "monthly",
"day": "1",
"hours": "9",
"minutes": "00",
"timezone": "America/New_York",
"recipients": [
"[email protected]"
],
"template_id": "tmplAbc123",
"sender_id": "sndrAbc123",
"date_text": "Last 30 Days"
}
'import requests
url = "https://api.oviond.com/v1/automations"
payload = {
"parent_id": "projAbc123",
"name": "Monthly Report",
"frequency": "monthly",
"day": "1",
"hours": "9",
"minutes": "00",
"timezone": "America/New_York",
"recipients": ["[email protected]"],
"template_id": "tmplAbc123",
"sender_id": "sndrAbc123",
"date_text": "Last 30 Days"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parent_id: 'projAbc123',
name: 'Monthly Report',
frequency: 'monthly',
day: '1',
hours: '9',
minutes: '00',
timezone: 'America/New_York',
recipients: ['[email protected]'],
template_id: 'tmplAbc123',
sender_id: 'sndrAbc123',
date_text: 'Last 30 Days'
})
};
fetch('https://api.oviond.com/v1/automations', 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://api.oviond.com/v1/automations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parent_id' => 'projAbc123',
'name' => 'Monthly Report',
'frequency' => 'monthly',
'day' => '1',
'hours' => '9',
'minutes' => '00',
'timezone' => 'America/New_York',
'recipients' => [
'[email protected]'
],
'template_id' => 'tmplAbc123',
'sender_id' => 'sndrAbc123',
'date_text' => 'Last 30 Days'
]),
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://api.oviond.com/v1/automations"
payload := strings.NewReader("{\n \"parent_id\": \"projAbc123\",\n \"name\": \"Monthly Report\",\n \"frequency\": \"monthly\",\n \"day\": \"1\",\n \"hours\": \"9\",\n \"minutes\": \"00\",\n \"timezone\": \"America/New_York\",\n \"recipients\": [\n \"[email protected]\"\n ],\n \"template_id\": \"tmplAbc123\",\n \"sender_id\": \"sndrAbc123\",\n \"date_text\": \"Last 30 Days\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.oviond.com/v1/automations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parent_id\": \"projAbc123\",\n \"name\": \"Monthly Report\",\n \"frequency\": \"monthly\",\n \"day\": \"1\",\n \"hours\": \"9\",\n \"minutes\": \"00\",\n \"timezone\": \"America/New_York\",\n \"recipients\": [\n \"[email protected]\"\n ],\n \"template_id\": \"tmplAbc123\",\n \"sender_id\": \"sndrAbc123\",\n \"date_text\": \"Last 30 Days\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.oviond.com/v1/automations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parent_id\": \"projAbc123\",\n \"name\": \"Monthly Report\",\n \"frequency\": \"monthly\",\n \"day\": \"1\",\n \"hours\": \"9\",\n \"minutes\": \"00\",\n \"timezone\": \"America/New_York\",\n \"recipients\": [\n \"[email protected]\"\n ],\n \"template_id\": \"tmplAbc123\",\n \"sender_id\": \"sndrAbc123\",\n \"date_text\": \"Last 30 Days\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"automation_id": "<string>",
"template_id": "<string>"
}
}{
"error": "<string>"
}