Skip to main content
POST
Add Connection Definition

Body

application/json
name
string
required
handle
string
required
type
enum<string>
required
Available options:
brand,
referral,
dependant,
stylist,
company,
partner,
household,
advisor,
staff_join,
staff_preferred,
gift,
external,
other
short_description
string | null
description
string | null
icon
string<uri> | null
cover
string<uri> | null
internal_notes
string | null
tenant
string | null
start_date_global
string<date-time> | null
end_date_global
string<date-time> | null
end_date_duration
integer | null
meta
string[] | null
shareable_attributes
string[] | null
connector_condition
string[] | null
connected_condition
string[] | null
connector_can_break
boolean | null
connected_can_break
boolean | null
is_published
boolean | null
is_pending
boolean | null
is_archived
boolean | null

Response

ConnectionDefinition

data
ConnectionDefinition · object
required