Skip to content

Create a routing form

POST
/appointments/routing-forms

Create a new routing form with optional fields and routes.

Returns the created form including its generated slug. is_admin is forced False so the form is owned by the API-key user.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
description
Any of:
string
disabled
boolean
fields
Array<object>
object
id
Any of:
string
identifier
Any of:
string
label
required
string
>= 1 characters <= 500 characters
options
Array<object>
object
event_type_id
Any of:
integer
label
required
string
>= 1 characters <= 500 characters
value
required
string
>= 1 characters <= 500 characters
placeholder
Any of:
string
required
boolean
default: true
type
string
default: select
Allowed values: text email phone number textarea select multiselect radio checkbox
name
required
string
>= 1 characters <= 255 characters
routes
Array<object>
object
action_type
string
default: redirect_event_type
Allowed values: redirect_event_type redirect_url show_message
action_value
string
""
conditions
Array<object>
object
field_id
required
string
>= 1 characters
operator
required
string
Allowed values: equals not_equals contains not_contains is_empty is_not_empty greater_than less_than select_equals select_not_equals
value
string
""
is_fallback
boolean
position
integer

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