API Reference - Website Labels

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

← Back to API Reference | Getting Started

Website Labels

Website Labels store the site-wide text strings used throughout your directory, such as button labels, field names, and UI copy. Each label has a key (field), a default value (result), and optional translations for German, French, and Spanish. Editing labels lets you rebrand the interface language without touching code.

Model name in URL: website_labels — DB table: website_labels

The Website Label Object

FieldTypeDescription
idintegerUnique label ID (primary key, read-only)
categorystringGrouping category for this label (EG general, member); max 255 characters
fieldstringUnique machine-readable key identifying this label (EG company_label2); max 255 characters required on create
resulttextDefault (English) value for this label required on create
result_detextGerman translation of this label
result_frtextFrench translation of this label
result_estextSpanish translation of this label
date_updatedstringDate this label was last updated (stored as a 14-character string, format YYYYMMDDHHMMSS); max 14 characters
prev_resulttextPrevious value of the label before the most recent edit (used for audit/rollback purposes)
desctextInternal description explaining where or how this label is used
revision_timestamptimestampTimestamp of the last modification to this record (auto-managed)

List Website Labels

GET /api/v2/website_labels/get

Example Request

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

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "id": "1",
      "category": "",
      "field": "company_label2",
      "result": "company",
      "result_de": "",
      "result_fr": "",
      "result_es": "",
      "date_updated": "",
      "prev_result": "company",
      "desc": "",
      "revision_timestamp": "2015-08-28 14:52:36"
    }
  ],
  "total": "230",
  "current_page": 1,
  "total_pages": 10,
  "next_page": "MipfKjI1"
}

Retrieve a Website Label

GET /api/v2/website_labels/get/{id}

Example Request

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

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "id": "1",
      "category": "",
      "field": "company_label2",
      "result": "company",
      "result_de": "",
      "result_fr": "",
      "result_es": "",
      "date_updated": "",
      "prev_result": "company",
      "desc": "",
      "revision_timestamp": "2015-08-28 14:52:36"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create a Website Label

POST /api/v2/website_labels/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/website_labels/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "category=member" \
  -d "field=join_button_label" \
  -d "result=Join+Now" \
  -d "result_es=Unirse+Ahora"

Example Response

Copy
{
  "status": "success",
  "message": {
    "id": "232",
    "category": "member",
    "field": "join_button_label",
    "result": "Join Now",
    "result_de": null,
    "result_fr": null,
    "result_es": "Unirse Ahora",
    "date_updated": null,
    "prev_result": null,
    "desc": null,
    "revision_timestamp": null
  }
}

Update a Website Label

PUT /api/v2/website_labels/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/website_labels/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "id=232" \
  -d "result=Sign+Up+Now" \
  -d "result_es=Registrarse+Ahora"

Example Response

Copy
{
  "status": "success",
  "message": {
    "id": "232",
    "category": "member",
    "field": "join_button_label",
    "result": "Sign Up Now",
    "result_de": "",
    "result_fr": "",
    "result_es": "Registrarse Ahora",
    "date_updated": "",
    "prev_result": "",
    "desc": "",
    "revision_timestamp": "2026-04-03 10:00:00"
  }
}

Delete a Website Label

DELETE /api/v2/website_labels/delete

Example Request

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

Example Response

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