Edit Connection Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/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>",
"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
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}"
payload = {
"name": "<string>",
"short_description": "<string>",
"description": "<string>",
"icon": "<string>",
"cover": "<string>",
"internal_notes": "<string>",
"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
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
short_description: '<string>',
description: '<string>',
icon: '<string>',
cover: '<string>',
internal_notes: '<string>',
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
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'short_description' => '<string>',
'description' => '<string>',
'icon' => '<string>',
'cover' => '<string>',
'internal_notes' => '<string>',
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"tenant\": \"<string>\",\n \"start_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_duration\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"shareable_attributes\": [\n \"<string>\"\n ],\n \"connector_condition\": [\n \"<string>\"\n ],\n \"connected_condition\": [\n \"<string>\"\n ],\n \"connector_can_break\": true,\n \"connected_can_break\": true,\n \"is_published\": true,\n \"is_pending\": true,\n \"is_archived\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"tenant\": \"<string>\",\n \"start_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_duration\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"shareable_attributes\": [\n \"<string>\"\n ],\n \"connector_condition\": [\n \"<string>\"\n ],\n \"connected_condition\": [\n \"<string>\"\n ],\n \"connector_can_break\": true,\n \"connected_can_break\": true,\n \"is_published\": true,\n \"is_pending\": true,\n \"is_archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"tenant\": \"<string>\",\n \"start_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_duration\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"shareable_attributes\": [\n \"<string>\"\n ],\n \"connector_condition\": [\n \"<string>\"\n ],\n \"connected_condition\": [\n \"<string>\"\n ],\n \"connector_can_break\": true,\n \"connected_can_break\": true,\n \"is_published\": true,\n \"is_pending\": true,\n \"is_archived\": true\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Connection Definition
Edit Connection Definition
A PUT to the /connection/definitions/{connectionDefinitionId} endpoint allows your application to edit a Tier Definition.
PUT
/
v3
/
connection
/
definitions
/
{definition}
Edit Connection Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/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>",
"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
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}"
payload = {
"name": "<string>",
"short_description": "<string>",
"description": "<string>",
"icon": "<string>",
"cover": "<string>",
"internal_notes": "<string>",
"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
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
short_description: '<string>',
description: '<string>',
icon: '<string>',
cover: '<string>',
internal_notes: '<string>',
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
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'short_description' => '<string>',
'description' => '<string>',
'icon' => '<string>',
'cover' => '<string>',
'internal_notes' => '<string>',
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"tenant\": \"<string>\",\n \"start_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_duration\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"shareable_attributes\": [\n \"<string>\"\n ],\n \"connector_condition\": [\n \"<string>\"\n ],\n \"connected_condition\": [\n \"<string>\"\n ],\n \"connector_can_break\": true,\n \"connected_can_break\": true,\n \"is_published\": true,\n \"is_pending\": true,\n \"is_archived\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"tenant\": \"<string>\",\n \"start_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_duration\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"shareable_attributes\": [\n \"<string>\"\n ],\n \"connector_condition\": [\n \"<string>\"\n ],\n \"connected_condition\": [\n \"<string>\"\n ],\n \"connector_can_break\": true,\n \"connected_can_break\": true,\n \"is_published\": true,\n \"is_pending\": true,\n \"is_archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/connection/definitions/{definition}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"tenant\": \"<string>\",\n \"start_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_global\": \"2023-11-07T05:31:56Z\",\n \"end_date_duration\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"shareable_attributes\": [\n \"<string>\"\n ],\n \"connector_condition\": [\n \"<string>\"\n ],\n \"connected_condition\": [\n \"<string>\"\n ],\n \"connector_can_break\": true,\n \"connected_can_break\": true,\n \"is_published\": true,\n \"is_pending\": true,\n \"is_archived\": true\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Path Parameters
The definition ID
Body
application/json
Available options:
brand, referral, dependant, stylist, company, partner, household, advisor, staff_join, staff_preferred, gift, external, other Response
ConnectionDefinition
Show child attributes
Show child attributes
⌘I