Skip to content

Create a workflow

POST
/appointments/workflows

Create a new workflow. Steps define the actions to take; event_type_ids attaches the workflow to specific event types (omit or set is_active_on_all to apply org-wide). trigger must be one of: new_booking, before_event, after_event, booking_cancelled, booking_rescheduled. Time-based triggers (before_event / after_event) require time and time_unit.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
event_type_ids
Any of:
Array<integer>
is_active_on_all
boolean
name
required
string
>= 1 characters <= 255 characters
steps
required
Array<object>
>= 1 items <= 20 items
object
action
required
string
Allowed values: email_host email_attendee email_address
email_subject
Any of:
string
<= 500 characters
include_calendar_event
boolean
reminder_body
Any of:
string
<= 20000 characters
send_to
Any of:
string format: email
sender
Any of:
string
<= 255 characters
template
string
default: reminder
Allowed values: reminder custom cancelled rescheduled completed rating
time
Any of:
integer
>= 1
time_unit
Any of:
string
Allowed values: minutes hours days
trigger
required
string
Allowed values: new_booking before_event after_event booking_cancelled booking_rescheduled

Responses

201

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string