Skip to main content
PUT
/
v3
/
connection
/
definitions
/
{definition}
Edit Connection Definition
curl --request PUT \
  --url http://localhost/api/v3/connection/definitions/{definition} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "short_description": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "cover": "<string>",
  "internal_notes": "<string>",
  "type": "brand",
  "tenant": "<string>",
  "start_date_global": "2023-11-07T05:31:56Z",
  "end_date_global": "2023-11-07T05:31:56Z",
  "end_date_duration": 123,
  "meta": [
    "<string>"
  ],
  "shareable_attributes": [
    "<string>"
  ],
  "connector_condition": [
    "<string>"
  ],
  "connected_condition": [
    "<string>"
  ],
  "connector_can_break": true,
  "connected_can_break": true,
  "is_published": true,
  "is_pending": true,
  "is_archived": true
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "short_description": "<string>",
    "description": "<string>",
    "icon": "<string>",
    "cover": "<string>",
    "internal_notes": "<string>",
    "type": "<string>",
    "tenant": "<string>",
    "start_date_global": "<string>",
    "end_date_global": "<string>",
    "end_date_duration": 123,
    "meta": [
      "<unknown>"
    ],
    "shareable_attributes": [
      "<unknown>"
    ],
    "connector_condition": [
      "<unknown>"
    ],
    "connected_condition": [
      "<unknown>"
    ],
    "connector_can_break": true,
    "connected_can_break": true,
    "is_published": true,
    "is_pending": true,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

definition
integer
required

The definition ID

Body

application/json
name
string
short_description
string | null
description
string | null
icon
string<uri> | null
cover
string<uri> | null
internal_notes
string | null
type
enum<string>
Available options:
brand,
referral,
dependant,
stylist,
company,
partner,
household,
advisor,
staff_join,
staff_preferred,
gift,
external,
other
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