Automations

Create Automation

Create a new automation for a report

post/v1/automations

Request

  • Base URL: https://api.oviond.com
  • URL: https://api.oviond.com/v1/automations
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

parent_idstring required

Report ID this automation belongs to

namestring required
frequency'daily' | 'weekly' | 'monthly' required
daystring
hoursstring required
minutesstring required
timezonestring required
time_format'AM' | 'PM'
recipientsstring[] required
template_idstring required

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

sender_idstring required

Saved email sender id

date_text'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' required

Example request

{
  "frequency": "weekly",
  "day": "monday",
  "hours": "9",
  "minutes": "00",
  "timezone": "America/New_York",
  "date_text": "Last 30 Days"
}

Response

Automation created

successtrue required

Changes

No recorded changes to this operation across all 2 revisions of this API.