Skip to main content
PUT
Edit Connection

Path Parameters

connection
integer
required

The connection ID

Body

application/json
name
string
description
string | null
status
enum<string>
Available options:
draft,
pending,
accepted,
rejected,
hold,
archived,
break
disconnected_by
string
connected_at
string<date-time> | null
disconnected_at
string<date-time> | null
is_published
boolean | null
is_default
boolean | null
is_archived
boolean | null
is_invalid
boolean | null
is_primary
boolean | null
sort_order
integer | null
meta
string[] | null
notes
string | null
external_id
string | null
external_id_type
enum<string> | null
Available options:
attributes_date,
interaction,
external,
transaction,
order,
product_list,
addresses
source_type
enum<string> | null
Available options:
profile,
product,
transaction,
reward,
benefit,
point,
user,
tenant,
list,
listItem,
target,
automation,
trigger,
aggregation,
comms_attribute,
appearance_attribute,
webhook,
identity,
tier,
address,
location,
product_variant,
benefit_definition,
reward_definition,
tier_definition,
transaction_item,
order,
redemption,
tier_point,
interaction,
status,
organisation,
role_definition,
credit_definition,
credit,
product_list_reservation,
appointment_definition,
appointment,
question,
questionnaire,
questionnaire_answer,
questionnaire_submission,
rating,
custom_attribute,
dates_attribute,
connection
source_id
integer | null
organisation_id
integer | null

Response

Connection

data
Connection · object
required