Full replace of an existing brand.
curl --request PUT \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"countryId": 123,
"logo": {
"name": "<string>",
"storageLocation": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"userDefinedId": "<string>"
}
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}"
payload = {
"name": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"countryId": 123,
"logo": {
"name": "<string>",
"storageLocation": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"userDefinedId": "<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>',
address: '<string>',
zipCode: '<string>',
city: '<string>',
stateOrProvince: '<string>',
countryId: 123,
logo: {
name: '<string>',
storageLocation: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
userDefinedId: '<string>'
})
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}",
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>',
'address' => '<string>',
'zipCode' => '<string>',
'city' => '<string>',
'stateOrProvince' => '<string>',
'countryId' => 123,
'logo' => [
'name' => '<string>',
'storageLocation' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'userDefinedId' => '<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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"countryId\": 123,\n \"logo\": {\n \"name\": \"<string>\",\n \"storageLocation\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"userDefinedId\": \"<string>\"\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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"countryId\": 123,\n \"logo\": {\n \"name\": \"<string>\",\n \"storageLocation\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"userDefinedId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}")
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 \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"countryId\": 123,\n \"logo\": {\n \"name\": \"<string>\",\n \"storageLocation\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"userDefinedId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": {
"id": 123,
"name": "<string>",
"organizationId": 123,
"state": "active",
"properties": [
"<string>"
],
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"country": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"logo": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"metadata": "<string>",
"size": 123,
"fileWidth": 123,
"fileHeight": 123,
"provider": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"storageLocation": "<string>",
"relatedEntityType": "style",
"relatedEntityId": 123,
"createdByOrganizationId": 123,
"isLink": true,
"isDeletedFromS3": true,
"fileIconUrl": "<string>",
"thumbnailNotFound": true
},
"marginFactor": 123,
"userDefinedId": "<string>",
"lastUpdated": "2023-11-07T05:31:56Z",
"logoThumbnails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"metadata": "<string>",
"size": 123,
"fileWidth": 123,
"fileHeight": 123,
"provider": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"storageLocation": "<string>",
"relatedEntityType": "style",
"relatedEntityId": 123,
"createdByOrganizationId": 123,
"isLink": true,
"isDeletedFromS3": true,
"fileIconUrl": "<string>",
"thumbnailNotFound": true
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Brands
Full replace of an existing brand.
Full replace: every field on the request body is written to the database verbatim. The route id is authoritative. Required fields (name, state) must be present and non-null; missing or null returns 400. Nullable scalar fields (address, zipCode, city, stateOrProvince, countryId, userDefinedId) clear the column when sent as null. Logo null clears LogoResourceId. Use PATCH for partial updates.
PUT
/
api
/
brands
/
{id}
Full replace of an existing brand.
curl --request PUT \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"countryId": 123,
"logo": {
"name": "<string>",
"storageLocation": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"userDefinedId": "<string>"
}
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}"
payload = {
"name": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"countryId": 123,
"logo": {
"name": "<string>",
"storageLocation": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"userDefinedId": "<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>',
address: '<string>',
zipCode: '<string>',
city: '<string>',
stateOrProvince: '<string>',
countryId: 123,
logo: {
name: '<string>',
storageLocation: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
userDefinedId: '<string>'
})
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}",
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>',
'address' => '<string>',
'zipCode' => '<string>',
'city' => '<string>',
'stateOrProvince' => '<string>',
'countryId' => 123,
'logo' => [
'name' => '<string>',
'storageLocation' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'userDefinedId' => '<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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"countryId\": 123,\n \"logo\": {\n \"name\": \"<string>\",\n \"storageLocation\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"userDefinedId\": \"<string>\"\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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"countryId\": 123,\n \"logo\": {\n \"name\": \"<string>\",\n \"storageLocation\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"userDefinedId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/brands/{id}")
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 \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"countryId\": 123,\n \"logo\": {\n \"name\": \"<string>\",\n \"storageLocation\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"userDefinedId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": {
"id": 123,
"name": "<string>",
"organizationId": 123,
"state": "active",
"properties": [
"<string>"
],
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"country": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"logo": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"metadata": "<string>",
"size": 123,
"fileWidth": 123,
"fileHeight": 123,
"provider": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"storageLocation": "<string>",
"relatedEntityType": "style",
"relatedEntityId": 123,
"createdByOrganizationId": 123,
"isLink": true,
"isDeletedFromS3": true,
"fileIconUrl": "<string>",
"thumbnailNotFound": true
},
"marginFactor": 123,
"userDefinedId": "<string>",
"lastUpdated": "2023-11-07T05:31:56Z",
"logoThumbnails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"metadata": "<string>",
"size": 123,
"fileWidth": 123,
"fileHeight": 123,
"provider": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"storageLocation": "<string>",
"relatedEntityType": "style",
"relatedEntityId": 123,
"createdByOrganizationId": 123,
"isLink": true,
"isDeletedFromS3": true,
"fileIconUrl": "<string>",
"thumbnailNotFound": true
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Headers
Path Parameters
Unique identifier of the brand to update. The route value is authoritative; the request body carries no id.
Body
application/jsontext/jsonapplication/*+json
Display name of the brand. Required.
Street address of the brand office.
Postal or ZIP code of the brand office.
City of the brand office.
State or province of the brand office.
Identifier of the country associated with the brand office. Omit or pass null to clear the country.
Optional reference to an uploaded file resource to use as the brand logo. Omit or pass null to leave the brand without a logo.
Show child attributes
Show child attributes
Lifecycle state to set on the brand. Required on a full-replace update.
Available options:
active, inactive, deleted Customer-defined identifier for the brand, useful for data imports, exports, and integrations.
Response
OK
The coarse outcome of the request, indicating whether it succeeded or failed.
Available options:
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.
Show child attributes
Show child attributes