Update a workflow (partial)

PATCH

/appointments/workflows/{workflow_id}

• Production
• QA

Partially update a workflow. Only the fields you send are changed; omit a field to leave it as-is. Steps are replaced wholesale when provided.

Authorizations

• BearerAuth

Parameters

Path Parameters

workflow_id

required

Workflow integer ID.

integer

>= 1

Workflow integer ID.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

event_type_ids

Any of:

Array<integer>

Array<integer>

null

null

is_active_on_all

Any of:

boolean

boolean

null

null

name

Any of:

string

string

>= 1 characters <= 255 characters

null

null

steps

Any of:

Array<object>

Array<object>

>= 1 items <= 20 items

object

action

required

string

Allowed values: email_host email_attendee email_address

email_subject

Any of:

string

string

<= 500 characters

null

null

include_calendar_event

boolean

reminder_body

Any of:

string

string

<= 20000 characters

null

null

send_to

Any of:

string

string format: email

null

null

sender

Any of:

string

string

<= 255 characters

null

null

template

string

default: reminder

Allowed values: reminder custom cancelled rescheduled completed rating

null

null

time

Any of:

integer

integer

>= 1

null

null

time_unit

Any of:

string

string

Allowed values: minutes hours days

null

null

trigger

Any of:

string

string

Allowed values: new_booking before_event after_event booking_cancelled booking_rescheduled

null

null

Responses

200

Successful Response

object

key

additional properties

any

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string