API Reference - Design Settings

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108116

← Back to API Reference | Getting Started

Design Settings

Design Settings control the visual appearance and layout configuration of your directory site. Each record stores a named setting (EG colors, fonts, layout options) along with its current value and the layout group it belongs to. These settings drive the site's theme rendering engine and are typically managed through the admin Design panel.

Model name in URL: website_design_settings — DB table: website_design_settings

The Design Setting Object

FieldTypeDescription
setting_idintegerUnique setting ID (primary key, read-only)
setting_namestringMachine-readable name identifying this design setting (EG primary_color, header_font); max 255 characters required on create
setting_valuetextCurrent value for this setting (EG a hex color code, font name, or numeric option) required on create
layout_groupstringThe layout or theme group this setting belongs to (EG default_layout); max 255 characters required on create
revision_timestamptimestampTimestamp of the last modification to this record (auto-managed)

List Design Settings

GET /api/v2/website_design_settings/get

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/website_design_settings/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "setting_id": "3",
      "setting_name": "website_id",
      "setting_value": "3579",
      "layout_group": "default_layout",
      "revision_timestamp": "2016-02-12 18:18:02"
    }
  ],
  "total": "769",
  "current_page": 1,
  "total_pages": 31,
  "next_page": "MipfKjI1"
}

Retrieve a Design Setting

GET /api/v2/website_design_settings/get/{setting_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/website_design_settings/get/3" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "setting_id": "3",
      "setting_name": "website_id",
      "setting_value": "3579",
      "layout_group": "default_layout",
      "revision_timestamp": "2016-02-12 18:18:02"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create a Design Setting

POST /api/v2/website_design_settings/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/website_design_settings/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "setting_name=custom_accent_color" \
  -d "setting_value=%23FF6600" \
  -d "layout_group=default_layout"

Example Response

Copy
{
  "status": "success",
  "message": {
    "setting_id": "5737",
    "setting_name": "custom_accent_color",
    "setting_value": "#FF6600",
    "layout_group": "default_layout",
    "revision_timestamp": null
  }
}

Update a Design Setting

PUT /api/v2/website_design_settings/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/website_design_settings/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "setting_id=5737" \
  -d "setting_value=%23CC5500"

Example Response

Copy
{
  "status": "success",
  "message": {
    "setting_id": "5737",
    "setting_name": "custom_accent_color",
    "setting_value": "#CC5500",
    "layout_group": "default_layout",
    "revision_timestamp": "2026-04-03 10:00:00"
  }
}

Delete a Design Setting

DELETE /api/v2/website_design_settings/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/website_design_settings/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "setting_id=5737"

Example Response

Copy
{
  "status": "success",
  "message": "website_design_settings record was deleted"
}