System Brand Settings

1 API call in this section.

Update Brand Settings

System Configuration / System Brand Settings

PUT/system-brand-settings/:id?language=en

Update system brand settings. Requires system admin access. All fields are optional but must match their expected data types. Headers: - Authorization: Bearer token for authentication (required) - Content-Type: application/json (required) - X-API-Key: Alternative authentication method using API key Path Parameters: - id: ID of the system brand settings to update Query Parameters: - language (optional): Language code for localized response messages (e.g., 'en') Request Body Fields (all optional): - brand_name: JSONB object with language keys - assets: JSONB object for brand assets - colors: JSONB object for brand colors - configurations: JSONB object for brand configurations - landing_page: JSONB object for landing page visibility, hero, docs, quick access, modules, and auth images - is_active: Boolean value to enable/disable the brand settings - default_preset_id: String value for the default preset ID Validation Rules: - brand_name must be a JSONB object - assets must be a JSONB object - colors must be a JSONB object - configurations must be a JSONB object - landing_page must be a JSONB object - is_active must be a boolean - default_preset_id must be a string

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request PUT "$ONDI_BASE_URL/system-brand-settings/:id?language=en" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "brand_name": {7    "en": "Ondi",8    "ar": "",9    "ku": ""10  },11  "landing_page": {12    "book_demo_link": {13      "visible": true14    },15    "hero": {16      "title": "Ondi",17      "subtitle": "Right on the distribution",18      "description": "Manage e-commerce, restaurant operations, delivery logistics, and more all from a single unified platform.",19      "image": ""20    },21    "documentation": {22      "visible": true,23      "platform": {24        "visible": true,25        "url": "https://docs.ondi.io"26      },27      "api": {28        "visible": true,29        "url": "https://api-docs.ondi.io"30      }31    },32    "quick_access": {33      "visible": true,34      "items": [35        {36          "id": "store-front",37          "visible": true,38          "title": "Store Front",39          "description": "Customer-facing e-commerce storefront",40          "image": "",41          "link_text": "store.ondi.io",42          "link_url": "https://store.ondi.io"43        }44      ]45    },46    "modules": {47      "visible": true,48      "items": [49        {50          "id": "store-front",51          "visible": true,52          "title": "Store front (E-Commerce)",53          "description": "Complete online store solution with product management, inventory, and checkout."54        }55      ]56    },57    "auth_images": {58      "login": "",59      "forgot_password": ""60    }61  },62  "configurations": {63    "theme": "dark"64  },65  "is_active": true,66  "default_preset_id": "preset-123"67}'

Request body

json

1{2  "brand_name": {3    "en": "Ondi",4    "ar": "",5    "ku": ""6  },7  "landing_page": {8    "book_demo_link": {9      "visible": true10    },11    "hero": {12      "title": "Ondi",13      "subtitle": "Right on the distribution",14      "description": "Manage e-commerce, restaurant operations, delivery logistics, and more all from a single unified platform.",15      "image": ""16    },17    "documentation": {18      "visible": true,19      "platform": {20        "visible": true,21        "url": "https://docs.ondi.io"22      },23      "api": {24        "visible": true,25        "url": "https://api-docs.ondi.io"26      }27    },28    "quick_access": {29      "visible": true,30      "items": [31        {32          "id": "store-front",33          "visible": true,34          "title": "Store Front",35          "description": "Customer-facing e-commerce storefront",36          "image": "",37          "link_text": "store.ondi.io",38          "link_url": "https://store.ondi.io"39        }40      ]41    },42    "modules": {43      "visible": true,44      "items": [45        {46          "id": "store-front",47          "visible": true,48          "title": "Store front (E-Commerce)",49          "description": "Complete online store solution with product management, inventory, and checkout."50        }51      ]52    },53    "auth_images": {54      "login": "",55      "forgot_password": ""56    }57  },58  "configurations": {59    "theme": "dark"60  },61  "is_active": true,62  "default_preset_id": "preset-123"63}

Path parameters

idRequired

path string

ID of the system brand settings to update

Query parameters

languageOptional

query string

Language code for response localization (Optional, default: en)