Edit Department
curl --request PUT \
--url https://api.{tenant}.getomneo.com/api/v3/departments/{department} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"brand_id": 123,
"external_id": "<string>",
"external_code": "<string>",
"location_id": 123,
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<string>"
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/departments/{department}"
payload = {
"name": "<string>",
"brand_id": 123,
"external_id": "<string>",
"external_code": "<string>",
"location_id": 123,
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": ["<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>',
brand_id: 123,
external_id: '<string>',
external_code: '<string>',
location_id: 123,
description: '<string>',
short_description: '<string>',
url: '<string>',
image_url: '<string>',
internal_note: '<string>',
meta: ['<string>']
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/departments/{department}', 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/departments/{department}",
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>',
'brand_id' => 123,
'external_id' => '<string>',
'external_code' => '<string>',
'location_id' => 123,
'description' => '<string>',
'short_description' => '<string>',
'url' => '<string>',
'image_url' => '<string>',
'internal_note' => '<string>',
'meta' => [
'<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/departments/{department}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"brand_id\": 123,\n \"external_id\": \"<string>\",\n \"external_code\": \"<string>\",\n \"location_id\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"meta\": [\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/departments/{department}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"brand_id\": 123,\n \"external_id\": \"<string>\",\n \"external_code\": \"<string>\",\n \"location_id\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/departments/{department}")
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 \"brand_id\": 123,\n \"external_id\": \"<string>\",\n \"external_code\": \"<string>\",\n \"location_id\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"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>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Department
Edit Department
A PUT to the /departments/{department} endpoint allows your application to edit department.
PUT
/
v3
/
departments
/
{department}
Edit Department
curl --request PUT \
--url https://api.{tenant}.getomneo.com/api/v3/departments/{department} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"brand_id": 123,
"external_id": "<string>",
"external_code": "<string>",
"location_id": 123,
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<string>"
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/departments/{department}"
payload = {
"name": "<string>",
"brand_id": 123,
"external_id": "<string>",
"external_code": "<string>",
"location_id": 123,
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": ["<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>',
brand_id: 123,
external_id: '<string>',
external_code: '<string>',
location_id: 123,
description: '<string>',
short_description: '<string>',
url: '<string>',
image_url: '<string>',
internal_note: '<string>',
meta: ['<string>']
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/departments/{department}', 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/departments/{department}",
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>',
'brand_id' => 123,
'external_id' => '<string>',
'external_code' => '<string>',
'location_id' => 123,
'description' => '<string>',
'short_description' => '<string>',
'url' => '<string>',
'image_url' => '<string>',
'internal_note' => '<string>',
'meta' => [
'<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/departments/{department}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"brand_id\": 123,\n \"external_id\": \"<string>\",\n \"external_code\": \"<string>\",\n \"location_id\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"meta\": [\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/departments/{department}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"brand_id\": 123,\n \"external_id\": \"<string>\",\n \"external_code\": \"<string>\",\n \"location_id\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/departments/{department}")
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 \"brand_id\": 123,\n \"external_id\": \"<string>\",\n \"external_code\": \"<string>\",\n \"location_id\": 123,\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"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>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Path Parameters
The department ID
Body
application/json
Response
Department
Show child attributes
Show child attributes
⌘I