Skip to main content
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": "<string>",
  "name": "<string>",
  "frequency": "weekly",
  "hours": "9",
  "minutes": "00",
  "timezone": "America/New_York",
  "recipients": [
    "[email protected]"
  ],
  "template_id": "<string>",
  "sender_id": "<string>",
  "date_text": "<string>",
  "day": "monday",
  "time_format": "<string>"
}
'
{
  "success": true,
  "data": {
    "automation_id": "<string>",
    "template_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
parent_id
string
required

Project ID this automation belongs to

Minimum string length: 1
​
name
string
required
​
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly
Example:

"weekly"

​
hours
string
required
Example:

"9"

​
minutes
string
required
Example:

"00"

​
timezone
string
required
Example:

"America/New_York"

​
recipients
string<email>[]
required
Minimum array length: 1
​
template_id
string
required

Saved email template id, or the literal "custom" to save a new template from the custom payload

Minimum string length: 1
​
sender_id
string
required

Saved email sender id

Minimum string length: 1
​
date_text
string
required
​
day
string
Example:

"monday"

​
time_format
string
​
custom
object

Required when template_id === "custom" — saved as a new named email template (name + subject + message)

Response

Automation created

​
success
enum<boolean>
required
Available options:
true
​
data
object
required