Edit List Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/api/v3/lists/definitions/{definition} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"icon": "<string>",
"cover": "<string>",
"timezone": "<string>",
"reservation_period": 123,
"reservation_absolute_expiry": "<string>",
"reservation_reserved_target_id": 123,
"reservation_notify_reserved_offset_days": 123,
"reservation_notify_reserved_offset_hours": 123,
"reservation_expiry_target_id": 123,
"reservation_remind_target_id": 123,
"reservation_notify_remind_offset_days": 123,
"reservation_notify_remind_offset_hours": 123,
"meta": [
"<string>"
],
"short_description": "<string>",
"description": "<string>",
"allow_share": true,
"allow_quantity": true,
"allow_reserve": true,
"allow_custom_product": true,
"is_published": true,
"is_active": true,
"allow_edit": true,
"allow_new": true,
"allow_delete": true,
"organisation_id": 123,
"tags": [
"<string>"
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/lists/definitions/{definition}"
payload = {
"name": "<string>",
"type": "<string>",
"icon": "<string>",
"cover": "<string>",
"timezone": "<string>",
"reservation_period": 123,
"reservation_absolute_expiry": "<string>",
"reservation_reserved_target_id": 123,
"reservation_notify_reserved_offset_days": 123,
"reservation_notify_reserved_offset_hours": 123,
"reservation_expiry_target_id": 123,
"reservation_remind_target_id": 123,
"reservation_notify_remind_offset_days": 123,
"reservation_notify_remind_offset_hours": 123,
"meta": ["<string>"],
"short_description": "<string>",
"description": "<string>",
"allow_share": True,
"allow_quantity": True,
"allow_reserve": True,
"allow_custom_product": True,
"is_published": True,
"is_active": True,
"allow_edit": True,
"allow_new": True,
"allow_delete": True,
"organisation_id": 123,
"tags": ["<string>"]
}
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>',
type: '<string>',
icon: '<string>',
cover: '<string>',
timezone: '<string>',
reservation_period: 123,
reservation_absolute_expiry: '<string>',
reservation_reserved_target_id: 123,
reservation_notify_reserved_offset_days: 123,
reservation_notify_reserved_offset_hours: 123,
reservation_expiry_target_id: 123,
reservation_remind_target_id: 123,
reservation_notify_remind_offset_days: 123,
reservation_notify_remind_offset_hours: 123,
meta: ['<string>'],
short_description: '<string>',
description: '<string>',
allow_share: true,
allow_quantity: true,
allow_reserve: true,
allow_custom_product: true,
is_published: true,
is_active: true,
allow_edit: true,
allow_new: true,
allow_delete: true,
organisation_id: 123,
tags: ['<string>']
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/lists/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/lists/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>',
'type' => '<string>',
'icon' => '<string>',
'cover' => '<string>',
'timezone' => '<string>',
'reservation_period' => 123,
'reservation_absolute_expiry' => '<string>',
'reservation_reserved_target_id' => 123,
'reservation_notify_reserved_offset_days' => 123,
'reservation_notify_reserved_offset_hours' => 123,
'reservation_expiry_target_id' => 123,
'reservation_remind_target_id' => 123,
'reservation_notify_remind_offset_days' => 123,
'reservation_notify_remind_offset_hours' => 123,
'meta' => [
'<string>'
],
'short_description' => '<string>',
'description' => '<string>',
'allow_share' => true,
'allow_quantity' => true,
'allow_reserve' => true,
'allow_custom_product' => true,
'is_published' => true,
'is_active' => true,
'allow_edit' => true,
'allow_new' => true,
'allow_delete' => true,
'organisation_id' => 123,
'tags' => [
'<string>'
]
]),
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/lists/definitions/{definition}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"timezone\": \"<string>\",\n \"reservation_period\": 123,\n \"reservation_absolute_expiry\": \"<string>\",\n \"reservation_reserved_target_id\": 123,\n \"reservation_notify_reserved_offset_days\": 123,\n \"reservation_notify_reserved_offset_hours\": 123,\n \"reservation_expiry_target_id\": 123,\n \"reservation_remind_target_id\": 123,\n \"reservation_notify_remind_offset_days\": 123,\n \"reservation_notify_remind_offset_hours\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"allow_share\": true,\n \"allow_quantity\": true,\n \"allow_reserve\": true,\n \"allow_custom_product\": true,\n \"is_published\": true,\n \"is_active\": true,\n \"allow_edit\": true,\n \"allow_new\": true,\n \"allow_delete\": true,\n \"organisation_id\": 123,\n \"tags\": [\n \"<string>\"\n ]\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/lists/definitions/{definition}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"timezone\": \"<string>\",\n \"reservation_period\": 123,\n \"reservation_absolute_expiry\": \"<string>\",\n \"reservation_reserved_target_id\": 123,\n \"reservation_notify_reserved_offset_days\": 123,\n \"reservation_notify_reserved_offset_hours\": 123,\n \"reservation_expiry_target_id\": 123,\n \"reservation_remind_target_id\": 123,\n \"reservation_notify_remind_offset_days\": 123,\n \"reservation_notify_remind_offset_hours\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"allow_share\": true,\n \"allow_quantity\": true,\n \"allow_reserve\": true,\n \"allow_custom_product\": true,\n \"is_published\": true,\n \"is_active\": true,\n \"allow_edit\": true,\n \"allow_new\": true,\n \"allow_delete\": true,\n \"organisation_id\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/lists/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 \"type\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"timezone\": \"<string>\",\n \"reservation_period\": 123,\n \"reservation_absolute_expiry\": \"<string>\",\n \"reservation_reserved_target_id\": 123,\n \"reservation_notify_reserved_offset_days\": 123,\n \"reservation_notify_reserved_offset_hours\": 123,\n \"reservation_expiry_target_id\": 123,\n \"reservation_remind_target_id\": 123,\n \"reservation_notify_remind_offset_days\": 123,\n \"reservation_notify_remind_offset_hours\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"allow_share\": true,\n \"allow_quantity\": true,\n \"allow_reserve\": true,\n \"allow_custom_product\": true,\n \"is_published\": true,\n \"is_active\": true,\n \"allow_edit\": true,\n \"allow_new\": true,\n \"allow_delete\": true,\n \"organisation_id\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"type": "<string>",
"icon": "<string>",
"cover": "<string>",
"short_description": "<string>",
"description": "<string>",
"allow_share": true,
"allow_quantity": true,
"allow_reserve": true,
"allow_custom_product": true,
"timezone": "<string>",
"reservation_period": 123,
"reservation_period_type": "<string>",
"reservation_absolute_expiry": "<string>",
"reservation_reserved_target_id": 123,
"reservation_notify_reserved_offset_days": 123,
"reservation_notify_reserved_offset_hours": 123,
"reservation_expiry_target_id": 123,
"reservation_remind_target_id": 123,
"reservation_notify_remind_offset_days": 123,
"reservation_notify_remind_offset_hours": 123,
"meta": [
"<unknown>"
],
"is_published": true,
"is_active": true,
"allow_edit": true,
"allow_new": true,
"allow_delete": true,
"tags": [
"<string>"
],
"organisation": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"type": "<string>",
"status": "<string>",
"is_tenant": 123,
"is_active": 123,
"phone": "<string>",
"email": "<string>",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": [
"<unknown>"
],
"meta": [
"<unknown>"
],
"locations": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
],
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"custom_fields": {},
"created_at": "<string>",
"updated_at": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}List Definition
Edit List Definition
A PUT to the /lists/definitions/{definitionId} endpoint allows your application to edit a List Definition.
PUT
/
v3
/
lists
/
definitions
/
{definition}
Edit List Definition
curl --request PUT \
--url https://api.{tenant}.getomneo.com/api/v3/lists/definitions/{definition} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"icon": "<string>",
"cover": "<string>",
"timezone": "<string>",
"reservation_period": 123,
"reservation_absolute_expiry": "<string>",
"reservation_reserved_target_id": 123,
"reservation_notify_reserved_offset_days": 123,
"reservation_notify_reserved_offset_hours": 123,
"reservation_expiry_target_id": 123,
"reservation_remind_target_id": 123,
"reservation_notify_remind_offset_days": 123,
"reservation_notify_remind_offset_hours": 123,
"meta": [
"<string>"
],
"short_description": "<string>",
"description": "<string>",
"allow_share": true,
"allow_quantity": true,
"allow_reserve": true,
"allow_custom_product": true,
"is_published": true,
"is_active": true,
"allow_edit": true,
"allow_new": true,
"allow_delete": true,
"organisation_id": 123,
"tags": [
"<string>"
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/lists/definitions/{definition}"
payload = {
"name": "<string>",
"type": "<string>",
"icon": "<string>",
"cover": "<string>",
"timezone": "<string>",
"reservation_period": 123,
"reservation_absolute_expiry": "<string>",
"reservation_reserved_target_id": 123,
"reservation_notify_reserved_offset_days": 123,
"reservation_notify_reserved_offset_hours": 123,
"reservation_expiry_target_id": 123,
"reservation_remind_target_id": 123,
"reservation_notify_remind_offset_days": 123,
"reservation_notify_remind_offset_hours": 123,
"meta": ["<string>"],
"short_description": "<string>",
"description": "<string>",
"allow_share": True,
"allow_quantity": True,
"allow_reserve": True,
"allow_custom_product": True,
"is_published": True,
"is_active": True,
"allow_edit": True,
"allow_new": True,
"allow_delete": True,
"organisation_id": 123,
"tags": ["<string>"]
}
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>',
type: '<string>',
icon: '<string>',
cover: '<string>',
timezone: '<string>',
reservation_period: 123,
reservation_absolute_expiry: '<string>',
reservation_reserved_target_id: 123,
reservation_notify_reserved_offset_days: 123,
reservation_notify_reserved_offset_hours: 123,
reservation_expiry_target_id: 123,
reservation_remind_target_id: 123,
reservation_notify_remind_offset_days: 123,
reservation_notify_remind_offset_hours: 123,
meta: ['<string>'],
short_description: '<string>',
description: '<string>',
allow_share: true,
allow_quantity: true,
allow_reserve: true,
allow_custom_product: true,
is_published: true,
is_active: true,
allow_edit: true,
allow_new: true,
allow_delete: true,
organisation_id: 123,
tags: ['<string>']
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/lists/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/lists/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>',
'type' => '<string>',
'icon' => '<string>',
'cover' => '<string>',
'timezone' => '<string>',
'reservation_period' => 123,
'reservation_absolute_expiry' => '<string>',
'reservation_reserved_target_id' => 123,
'reservation_notify_reserved_offset_days' => 123,
'reservation_notify_reserved_offset_hours' => 123,
'reservation_expiry_target_id' => 123,
'reservation_remind_target_id' => 123,
'reservation_notify_remind_offset_days' => 123,
'reservation_notify_remind_offset_hours' => 123,
'meta' => [
'<string>'
],
'short_description' => '<string>',
'description' => '<string>',
'allow_share' => true,
'allow_quantity' => true,
'allow_reserve' => true,
'allow_custom_product' => true,
'is_published' => true,
'is_active' => true,
'allow_edit' => true,
'allow_new' => true,
'allow_delete' => true,
'organisation_id' => 123,
'tags' => [
'<string>'
]
]),
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/lists/definitions/{definition}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"timezone\": \"<string>\",\n \"reservation_period\": 123,\n \"reservation_absolute_expiry\": \"<string>\",\n \"reservation_reserved_target_id\": 123,\n \"reservation_notify_reserved_offset_days\": 123,\n \"reservation_notify_reserved_offset_hours\": 123,\n \"reservation_expiry_target_id\": 123,\n \"reservation_remind_target_id\": 123,\n \"reservation_notify_remind_offset_days\": 123,\n \"reservation_notify_remind_offset_hours\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"allow_share\": true,\n \"allow_quantity\": true,\n \"allow_reserve\": true,\n \"allow_custom_product\": true,\n \"is_published\": true,\n \"is_active\": true,\n \"allow_edit\": true,\n \"allow_new\": true,\n \"allow_delete\": true,\n \"organisation_id\": 123,\n \"tags\": [\n \"<string>\"\n ]\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/lists/definitions/{definition}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"timezone\": \"<string>\",\n \"reservation_period\": 123,\n \"reservation_absolute_expiry\": \"<string>\",\n \"reservation_reserved_target_id\": 123,\n \"reservation_notify_reserved_offset_days\": 123,\n \"reservation_notify_reserved_offset_hours\": 123,\n \"reservation_expiry_target_id\": 123,\n \"reservation_remind_target_id\": 123,\n \"reservation_notify_remind_offset_days\": 123,\n \"reservation_notify_remind_offset_hours\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"allow_share\": true,\n \"allow_quantity\": true,\n \"allow_reserve\": true,\n \"allow_custom_product\": true,\n \"is_published\": true,\n \"is_active\": true,\n \"allow_edit\": true,\n \"allow_new\": true,\n \"allow_delete\": true,\n \"organisation_id\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/lists/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 \"type\": \"<string>\",\n \"icon\": \"<string>\",\n \"cover\": \"<string>\",\n \"timezone\": \"<string>\",\n \"reservation_period\": 123,\n \"reservation_absolute_expiry\": \"<string>\",\n \"reservation_reserved_target_id\": 123,\n \"reservation_notify_reserved_offset_days\": 123,\n \"reservation_notify_reserved_offset_hours\": 123,\n \"reservation_expiry_target_id\": 123,\n \"reservation_remind_target_id\": 123,\n \"reservation_notify_remind_offset_days\": 123,\n \"reservation_notify_remind_offset_hours\": 123,\n \"meta\": [\n \"<string>\"\n ],\n \"short_description\": \"<string>\",\n \"description\": \"<string>\",\n \"allow_share\": true,\n \"allow_quantity\": true,\n \"allow_reserve\": true,\n \"allow_custom_product\": true,\n \"is_published\": true,\n \"is_active\": true,\n \"allow_edit\": true,\n \"allow_new\": true,\n \"allow_delete\": true,\n \"organisation_id\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"type": "<string>",
"icon": "<string>",
"cover": "<string>",
"short_description": "<string>",
"description": "<string>",
"allow_share": true,
"allow_quantity": true,
"allow_reserve": true,
"allow_custom_product": true,
"timezone": "<string>",
"reservation_period": 123,
"reservation_period_type": "<string>",
"reservation_absolute_expiry": "<string>",
"reservation_reserved_target_id": 123,
"reservation_notify_reserved_offset_days": 123,
"reservation_notify_reserved_offset_hours": 123,
"reservation_expiry_target_id": 123,
"reservation_remind_target_id": 123,
"reservation_notify_remind_offset_days": 123,
"reservation_notify_remind_offset_hours": 123,
"meta": [
"<unknown>"
],
"is_published": true,
"is_active": true,
"allow_edit": true,
"allow_new": true,
"allow_delete": true,
"tags": [
"<string>"
],
"organisation": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"type": "<string>",
"status": "<string>",
"is_tenant": 123,
"is_active": 123,
"phone": "<string>",
"email": "<string>",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": [
"<unknown>"
],
"meta": [
"<unknown>"
],
"locations": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
],
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"custom_fields": {},
"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:
days, weeks, months, years, absolute_date, absolute_week, absolute_month Response
ListDefinition
Show child attributes
Show child attributes
⌘I