brilliant-directories-mcp 6.7.0 → 6.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +2 -0
- package/openapi/bd-api.json +42 -20
- package/package.json +1 -1
package/index.js
CHANGED
|
@@ -704,6 +704,8 @@ async function main() {
|
|
|
704
704
|
``,
|
|
705
705
|
`Hero image sourcing — agents must pick a CONTENT-RELEVANT stock photo for every hero they create; never use random/placeholder generators (picsum.photos, lorem pixel, placekitten, etc. — those change on each page load, which looks broken to real users). Preferred source: **Pexels** (https://www.pexels.com) — free license, no attribution required, stable URLs, reliable image hotlinking. Workflow: pick a search term from the page topic (e.g. page about "doctors in LA" → search "doctor office" or "medical professional"; IVF clinics → "fertility clinic" or "couple holding hands"; beauty salons → "hair salon interior"), choose a safe-for-work image without watermarks/logos, and use the **"large" variant URL** (Pexels' direct-download-large size — NOT "original" which is often 5000+px and too heavy for a hero banner). Pexels large URL pattern: \`https://images.pexels.com/photos/<ID>/pexels-photo-<ID>.jpeg?auto=compress&cs=tinysrgb&w=1800\`. If the user supplies their own image URL, use that instead. Never hotlink from sources with restrictive licenses (Getty, Shutterstock watermark-stripped, etc.) — reputational risk for the site.`,
|
|
706
706
|
``,
|
|
707
|
+
`users_meta IDENTITY RULE (applies to every users_meta read, update, and delete — no exceptions). A users_meta row is identified by the PAIR \`(database, database_id)\` PLUS a \`key\`. The same \`database_id\` value can exist in the users_meta table pointing at different parent tables — e.g. \`database_id=123\` might refer to a row in \`users_data\`, \`list_seo\`, \`data_posts\`, and \`subscription_types\` all at once, and they are completely unrelated records on different tables that happen to share the same numeric ID. When reading, updating, or (especially) DELETING users_meta rows: (a) ALWAYS filter/match on BOTH \`database\` AND \`database_id\` together — never just \`database_id\` alone. (b) NEVER loop-delete by \`database_id\` alone — this WILL delete unrelated records on other tables. (c) When the MCP list tool doesn't expose array-syntax multi-filter, list by whichever single field narrows hardest (usually \`database_id\`), then client-side filter the results by \`database\` match before acting. (d) This is a strict safety rule: a single agent mistake here can cascade-destroy member data, plan metadata, and page settings that happen to share the same ID number across unrelated tables.`,
|
|
708
|
+
``,
|
|
707
709
|
`WebPage users_meta field-update workaround (CRITICAL). BD's \`list_seo\` table has a mix of DIRECT columns and EAV-stored fields in the \`users_meta\` table (keyed by database=list_seo + database_id=<seo_id> + key=<field>). On CREATE, \`createWebPage\` writes ALL fields correctly — direct columns AND users_meta rows are seeded together. On UPDATE, \`updateWebPage\` only writes the direct columns — the users_meta-stored fields are SILENTLY IGNORED (the write succeeds but the new value doesn't persist, live-verified). To update any of the following fields on an existing \`list_seo\` record, you MUST use \`updateUserMeta\` (or \`createUserMeta\` if the row doesn't exist yet) instead: \`linked_post_category\`, \`linked_post_type\`, \`disable_preview_screenshot\`, \`disable_css_stylesheets\`, \`hero_content_overlay_opacity\`, \`hero_link_target_blank\`, \`hero_background_image_size\`, \`hero_link_size\`, \`hero_link_color\`, \`hero_content_font_size\`, \`hero_section_content\`, \`hero_column_width\`, \`h2_font_weight\`, \`h1_font_weight\`, \`h2_font_size\`, \`h1_font_size\`, \`hero_link_text\`, \`hero_link_url\`. Workflow for each update: (1) \`listUserMeta\` with filter \`database=list_seo\`, \`database_id=<seo_id>\`, \`key=<field>\` to find the existing \`meta_id\`; (2) if found → \`updateUserMeta(meta_id=..., value=<new value>)\`; (3) if not found → \`createUserMeta(database=list_seo, database_id=<seo_id>, key=<field>, value=<new value>)\`. **Reads merge automatically** — \`getWebPage\` / \`listWebPages\` return the merged record including users_meta values at the top level; you do NOT need to query UserMeta separately for reads. **Delete cleanup:** when an agent calls \`deleteWebPage\`, it deletes the \`list_seo\` row but does NOT cascade-delete the corresponding users_meta rows. To prevent garbage buildup, after \`deleteWebPage(seo_id)\`, call \`listUserMeta\` with \`database=list_seo\`, \`database_id=<deleted seo_id>\` to find any orphan meta rows, then \`deleteUserMeta\` each one by its \`meta_id\`. Be SURGICAL — only delete meta rows where \`database_id\` exactly matches the deleted page's \`seo_id\`; never bulk-delete across other database_ids or other database-table values.`,
|
|
708
710
|
``,
|
|
709
711
|
`Member Search Results SEO pages — thin-content remedy: BD auto-generates dynamic search URLs for every valid location+category combo (e.g. \`california/beverly-hills/plumbers\`). Google penalizes thin pages (1–2 members). Convert to static via \`createWebPage\` with \`seo_type="profile_search_results"\` + \`filename=<exact slug>\` + custom SEO copy in \`content\`. Slug hierarchy (no leading slash, \`/\`-separated, any left-parent droppable): \`country/state/city/top_cat/sub_cat\`. **CRITICAL: \`filename\` MUST be a real location/category slug BD's dynamic router recognizes** — every segment must come from live lookups against \`listCountries\`/\`listStates\`/\`listCities\`/\`listTopCategories\`/\`listSubCategories\`. Arbitrary or made-up slugs (e.g. \`my-cool-page\`, \`foo-bar\`) return HTTP 404 on the public URL even though the \`list_seo\` record is created successfully — BD has no dynamic page to override. Country-only slug (\`united-states\` alone) also does NOT render for this page type — country slug only works as a left-parent PREFIX on longer slugs. For arbitrary-URL static pages, use \`seo_type=content\` instead (content pages route at any \`filename\`). Resolve segments via: \`listCountries\` (country slug = lowercase country_name with spaces → hyphens — no country_filename field exists), \`listStates\` (\`state_filename\`), \`listCities\` (\`city_filename\` — BD schema typo: city PK is \`locaiton_id\` NOT \`location_id\`, pass the typo'd form), \`listTopCategories\` (\`filename\`), \`listSubCategories\` (\`filename\`). Before create, check existence via \`listWebPages property=filename property_value=<slug>\`. **Required defaults on create and every update for profile_search_results pages** (unless user overrides): \`content_active=1\`, \`custom_html_placement=4\`, \`form_name="Member Profile Page"\` (sidebar), \`menu_layout=3\` (Left Slim), \`date_updated=<current YYYYMMDDHHmmss timestamp>\` (BD does NOT auto-populate — always set to now on every write), \`updated_by\` (optional audit label like "AI Agent" or "API"). **Must auto-generate SEO meta for the specific location+category combo** — \`title\` (50–60 chars), \`meta_desc\` (150–160 chars), \`meta_keywords\` (~200 chars), \`facebook_title\` (55–60 chars, differ from title), \`facebook_desc\` (110–125 chars) — using human names (not slugs), natural "[city] [category]" / "in [location]" phrasing. Do NOT auto-set \`facebook_image\` (needs a user-uploaded asset). H1/H2 double-render trap: if hero enabled AND \`content\` contains \`<h1>\`/\`<h2>\`, both render — pick one location or the other, not both. Location + Sidebar CRUD are read-only by design in this MCP (create/delete deliberately omitted to prevent collisions with BD's auto-seeding and system layouts).`,
|
package/openapi/bd-api.json
CHANGED
|
@@ -7020,7 +7020,7 @@
|
|
|
7020
7020
|
}
|
|
7021
7021
|
}
|
|
7022
7022
|
},
|
|
7023
|
-
"description": "Paginated enumeration of
|
|
7023
|
+
"description": "Paginated enumeration of users_meta records (EAV key/value table). Read-only.\n\n**Use when:** enumerating metadata rows (key/value pairs) attached to a parent record in any BD table.\n\n**⚠️ IDENTITY RULE — filter by `database` AND `database_id` together, never just `database_id` alone.** The same `database_id` value can exist in users_meta pointing at different parent tables simultaneously — e.g. `database_id=123` may refer to rows in `users_data`, `list_seo`, `data_posts`, and `subscription_types` as four UNRELATED records. If you only filter by `database_id`, you'll get rows from all of them mixed together. ALWAYS also filter by `database=<parent_table>` (e.g. `list_seo`, `users_data`) — either via array-syntax multi-filter if supported, OR by listing by `database_id` and client-side filtering the results by the `database` field before acting. This rule is critical for all downstream writes (`updateUserMeta`, `deleteUserMeta`) — misidentifying a row can silently corrupt unrelated resource metadata.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` token from the previous response's `next_page`. Do not assume integer offsets.\n\n**Filter/sort:** `property` + `property_value` + `property_operator` (`=`, `LIKE`, `>`, `<`, `>=`, `<=`) to filter; `order_column` + `order_type` (`ASC`/`DESC`) to sort. Useful filters: `database`, `database_id`, `key`.\n\n**See also:** `getUserMeta` (single record by ID), `updateUserMeta`, `deleteUserMeta`.\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record includes `meta_id`, `database`, `database_id`, `key`, `value`, `date_added`, `revision_timestamp`.\n\n**Note on duplicates:** BD does NOT enforce a uniqueness constraint on `(database, database_id, key)` — the same field can have multiple rows (observed live). Read-layer merge uses last-write-wins, but stored data can bloat. When updating, consider patching ALL matching rows, or deleting duplicates first.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7024
7024
|
}
|
|
7025
7025
|
},
|
|
7026
7026
|
"/api/v2/users_meta/get/{meta_id}": {
|
|
@@ -7052,7 +7052,7 @@
|
|
|
7052
7052
|
}
|
|
7053
7053
|
}
|
|
7054
7054
|
},
|
|
7055
|
-
"description": "Fetch a single usermeta record. Read-only.\n\n**Use when:** fetching one metadata row by `meta_id`.\n\n**Required:** `meta_id`.\n\n**See also:** `listUserMeta` (enumerate many).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }` — the `message` array contains 1 record when found. Empty or HTTP 404 when not found.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7055
|
+
"description": "Fetch a single usermeta record. Read-only.\n\n**Use when:** fetching one metadata row by `meta_id`.\n\n**Required:** `meta_id`.\n\n**⚠️ Identity check before downstream writes:** Before using this row's `meta_id` for any subsequent `updateUserMeta`/`deleteUserMeta` call, confirm the response's `database` and `database_id` fields match the parent record you intend to modify. The same `database_id` can exist across unrelated parent tables (`users_data`, `list_seo`, `subscription_types`, etc.) — blindly passing a `meta_id` forward without verifying its identity pair can silently corrupt or destroy data on an unrelated table.\n\n**See also:** `listUserMeta` (enumerate many).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }` — the `message` array contains 1 record when found. Empty or HTTP 404 when not found.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7056
7056
|
}
|
|
7057
7057
|
},
|
|
7058
7058
|
"/api/v2/users_meta/create": {
|
|
@@ -7110,7 +7110,7 @@
|
|
|
7110
7110
|
}
|
|
7111
7111
|
}
|
|
7112
7112
|
},
|
|
7113
|
-
"description": "Create a new users_meta record (EAV key/value attached to any BD table row). Writes live data.\n\n**Use when:**\n- Attaching an arbitrary custom key/value to a member (`database=users_data`, `database_id=<user_id>`)\n- Writing to a subscription plan extension (`database=subscription_types`)\n- **Critical BD pattern: updating WebPage (`list_seo`) fields that `updateWebPage` doesn't persist on the update path.** BD's `list_seo` table mixes direct columns with EAV-stored fields in `users_meta`. On UPDATE, `updateWebPage` only writes direct columns — for these 18 fields you MUST use `createUserMeta` (if the meta row doesn't exist) or `updateUserMeta` (if it does): `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`. Pattern: `database=list_seo`, `database_id=<seo_id>`, `key=<field>`, `value=<value>`.\n\n**Required:** `database`, `database_id`, `key`, `value`.\n\n**Parameter interactions:**\n- `database` — target BD table name (e.g. `users_data`, `subscription_types`, `list_seo`, `data_posts`)\n- `database_id` — PK of the record in that table to attach metadata to\n- `key` — the meta field name. Must match the spelling the rendering layer expects (e.g. `hero_content_overlay_opacity` for the hero overlay).\n- `value` — stored as longtext; any string or serialized value\n- `date_added` — optional, `YYYYMMDDHHmmss`\n\n**Workflow for updating a users_meta field on an existing parent record:**\n1. `listUserMeta` with filter `database=<table>`, `database_id=<id>`, `key=<field>` — to check if the row already exists.\n2. If row exists →
|
|
7113
|
+
"description": "Create a new users_meta record (EAV key/value attached to any BD table row). Writes live data.\n\n**Use when:**\n- Attaching an arbitrary custom key/value to a member (`database=users_data`, `database_id=<user_id>`)\n- Writing to a subscription plan extension (`database=subscription_types`)\n- **Critical BD pattern: updating WebPage (`list_seo`) fields that `updateWebPage` doesn't persist on the update path.** BD's `list_seo` table mixes direct columns with EAV-stored fields in `users_meta`. On UPDATE, `updateWebPage` only writes direct columns — for these 18 fields you MUST use `createUserMeta` (if the meta row doesn't exist) or `updateUserMeta` (if it does): `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`. Pattern: `database=list_seo`, `database_id=<seo_id>`, `key=<field>`, `value=<value>`.\n\n**Required:** `database`, `database_id`, `key`, `value`.\n\n**Parameter interactions:**\n- `database` — target BD table name (e.g. `users_data`, `subscription_types`, `list_seo`, `data_posts`)\n- `database_id` — PK of the record in that table to attach metadata to\n- `key` — the meta field name. Must match the spelling the rendering layer expects (e.g. `hero_content_overlay_opacity` for the hero overlay).\n- `value` — stored as longtext; any string or serialized value\n- `date_added` — optional, `YYYYMMDDHHmmss`\n\n**Workflow for updating a users_meta field on an existing parent record:**\n1. `listUserMeta` with filter `database=<table>`, `database_id=<id>`, `key=<field>` — to check if the row already exists.\n2. If row exists → `updateUserMeta(meta_id, value=<new>, database=<table>, database_id=<id>)` — all four required as of v6.7.1.\n3. If row does NOT exist → `createUserMeta(database=<table>, database_id=<id>, key=<field>, value=<new>)`.\n\n**After hero/layout EAV-field creates on a WebPage:** call `refreshSiteCache` so changes show publicly. Applies equally to creating a brand-new EAV row for a hero/layout field and to updating one.\n\n**See also:** `updateUserMeta` (modify existing), `listUserMeta` (check for existing row first), `deleteUserMeta` (clean up orphans after parent-record deletion).\n\n**Cleanup rule:** when an agent deletes a parent record (e.g. `deleteWebPage(seo_id=X)`), BD does NOT cascade-delete the corresponding users_meta rows. List orphans via `listUserMeta(database=list_seo, database_id=X)`, client-side filter to rows whose `database` equals `list_seo`, then call `deleteUserMeta(meta_id=..., database=list_seo, database_id=X)` for each — all three required as of v6.7.1. Surgical only — never bulk-delete across unrelated `database_id`s.\n\n**Writes live data:** confirm intent for bulk operations.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the new `meta_id`.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7114
7114
|
}
|
|
7115
7115
|
},
|
|
7116
7116
|
"/api/v2/users_meta/update": {
|
|
@@ -7128,7 +7128,9 @@
|
|
|
7128
7128
|
"type": "object",
|
|
7129
7129
|
"required": [
|
|
7130
7130
|
"meta_id",
|
|
7131
|
-
"value"
|
|
7131
|
+
"value",
|
|
7132
|
+
"database",
|
|
7133
|
+
"database_id"
|
|
7132
7134
|
],
|
|
7133
7135
|
"properties": {
|
|
7134
7136
|
"meta_id": {
|
|
@@ -7136,6 +7138,14 @@
|
|
|
7136
7138
|
},
|
|
7137
7139
|
"value": {
|
|
7138
7140
|
"type": "string"
|
|
7141
|
+
},
|
|
7142
|
+
"database": {
|
|
7143
|
+
"type": "string",
|
|
7144
|
+
"description": "REQUIRED — parent table name this meta row is attached to (e.g. `list_seo`, `users_data`, `subscription_types`). MUST match the `database` value stored on the row being updated. This is a hard safety rule — the same `meta_id` verification plus `(database, database_id)` scoping prevents cross-table metadata corruption since the same `database_id` number can exist across multiple parent tables."
|
|
7145
|
+
},
|
|
7146
|
+
"database_id": {
|
|
7147
|
+
"type": "integer",
|
|
7148
|
+
"description": "REQUIRED — PK of the parent record this meta row is attached to. MUST match the `database_id` value stored on the row being updated. Same safety rule as `database`: the same numeric ID can belong to unrelated rows on different tables."
|
|
7139
7149
|
}
|
|
7140
7150
|
}
|
|
7141
7151
|
}
|
|
@@ -7154,7 +7164,7 @@
|
|
|
7154
7164
|
}
|
|
7155
7165
|
}
|
|
7156
7166
|
},
|
|
7157
|
-
"description": "Update an existing users_meta record's `value` by `meta_id`. Fields omitted are untouched. Writes live data.\n\n**Use when:**\n- Changing a metadata value on any BD table row that was previously created via `createUserMeta`.\n- **Critical BD pattern: updating WebPage (`list_seo`) fields that `updateWebPage` silently skips.** BD's `list_seo` table mixes direct columns with EAV-stored values in `users_meta`. The `updateWebPage` endpoint only writes direct columns; for these 18 fields you MUST use this endpoint: `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`.\n\n**Workflow:** find the `meta_id` by calling `listUserMeta` with filter `database=<table>`, `database_id=<parent_id>`, `key=<field>`. Then call this endpoint with `meta_id` + `
|
|
7167
|
+
"description": "Update an existing users_meta record's `value` by `meta_id`. Fields omitted are untouched. Writes live data.\n\n**⚠️ IDENTITY RULE — ALWAYS confirm BOTH `database` AND `database_id` before updating.** A users_meta row is identified by the PAIR `(database, database_id)` PLUS `key`. The same `database_id` value can exist pointing at different parent tables (e.g. `database_id=120` might refer to a member in `users_data` AND a page in `list_seo` AND a subscription in `subscription_types` — completely unrelated records sharing the same ID). ALWAYS verify the row's `database` field matches the table you intend to modify BEFORE calling `updateUserMeta` — misidentifying the row could silently overwrite unrelated resource metadata.\n\n**Use when:**\n- Changing a metadata value on any BD table row that was previously created via `createUserMeta`.\n- **Critical BD pattern: updating WebPage (`list_seo`) fields that `updateWebPage` silently skips.** BD's `list_seo` table mixes direct columns with EAV-stored values in `users_meta`. The `updateWebPage` endpoint only writes direct columns; for these 18 fields you MUST use this endpoint: `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`.\n\n**Workflow:** find the `meta_id` by calling `listUserMeta` with filter `database=<table>`, `database_id=<parent_id>`, `key=<field>`. Then call this endpoint with `meta_id`, `value`, and the same `database` + `database_id` you used for lookup. If no row exists for that combo, use `createUserMeta` instead.\n\n**Required (v6.7.1):** `meta_id`, `value`, `database`, `database_id`. All four — always. The identity pair (`database`, `database_id`) is enforced at the schema level to prevent cross-table corruption.\n\n**After hero/layout updates on a WebPage:** call `refreshSiteCache` so changes show publicly.\n\n**See also:** `createUserMeta` (add new when no row exists), `listUserMeta` (find the `meta_id` by filter), `deleteUserMeta` (remove permanently).\n\n**Writes live data:** confirm intent with the user for bulk operations. Changes are immediately visible on the live site.\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }` — the full updated record after changes applied.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7158
7168
|
}
|
|
7159
7169
|
},
|
|
7160
7170
|
"/api/v2/users_meta/delete": {
|
|
@@ -7171,11 +7181,21 @@
|
|
|
7171
7181
|
"schema": {
|
|
7172
7182
|
"type": "object",
|
|
7173
7183
|
"required": [
|
|
7174
|
-
"meta_id"
|
|
7184
|
+
"meta_id",
|
|
7185
|
+
"database",
|
|
7186
|
+
"database_id"
|
|
7175
7187
|
],
|
|
7176
7188
|
"properties": {
|
|
7177
7189
|
"meta_id": {
|
|
7178
7190
|
"type": "integer"
|
|
7191
|
+
},
|
|
7192
|
+
"database": {
|
|
7193
|
+
"type": "string",
|
|
7194
|
+
"description": "REQUIRED — parent table name (e.g. `list_seo`, `users_data`). Must match the row's stored `database` field. Prevents accidental cross-table deletion since the same `database_id` can exist in multiple parent tables."
|
|
7195
|
+
},
|
|
7196
|
+
"database_id": {
|
|
7197
|
+
"type": "integer",
|
|
7198
|
+
"description": "REQUIRED — parent record PK. Must match the row's stored `database_id` field. Agents MUST verify both `database` and `database_id` before calling delete to prevent destroying unrelated metadata on other tables with the same ID number."
|
|
7179
7199
|
}
|
|
7180
7200
|
}
|
|
7181
7201
|
}
|
|
@@ -7194,7 +7214,7 @@
|
|
|
7194
7214
|
}
|
|
7195
7215
|
}
|
|
7196
7216
|
},
|
|
7197
|
-
"description": "Permanently delete a
|
|
7217
|
+
"description": "Permanently delete a users_meta record by `meta_id`. DESTRUCTIVE — cannot be undone via API.\n\n**⚠️ HARD RULE — verify BOTH `database` AND `database_id` of the row BEFORE deleting.** A users_meta row is identified by the PAIR `(database, database_id)` PLUS `key`. The same `database_id` can point at different parent tables — e.g. `database_id=123` may refer to a row in `users_data`, `list_seo`, `data_posts`, and `subscription_types` simultaneously as four UNRELATED records. BEFORE calling this endpoint: (1) call `getUserMeta(meta_id)` or keep the row's full object from a prior `listUserMeta` response; (2) confirm the row's `database` value matches the table you intend to clean up. If you're batch-deleting orphans after a parent delete: list by the parent's `database_id`, then CLIENT-SIDE filter to ONLY the rows where `database` equals the parent table's name BEFORE deleting any `meta_id`. NEVER loop-delete by `database_id` alone — you will destroy unrelated resource metadata (member data, plan metadata, page settings) that happen to share the same numeric ID on other tables.\n\n**Use when:** removing a specific metadata row, OR cleaning up orphan meta rows after a parent record is deleted (BD does not cascade-delete users_meta when a parent is removed — it's the agent's job to find and delete the orphan rows surgically).\n\n**Required (v6.7.1):** `meta_id`, `database`, `database_id`. All three — always. The identity pair (`database`, `database_id`) is enforced at the schema level to prevent cross-table destruction.\n\n**Post-parent-delete cleanup workflow (safe pattern):**\n1. `listUserMeta` with filter `database_id=<deleted parent's id>`\n2. In the returned array, filter CLIENT-SIDE to ONLY rows where `database` equals the parent table's name (e.g. `list_seo` for a deleted WebPage)\n3. For each filtered `meta_id`, call `deleteUserMeta(meta_id, database=<parent table>, database_id=<parent id>)` — all three required as of v6.7.1\n4. Never skip step 2 — the same `database_id` can belong to unrelated rows on other tables\n\n**See also:** `updateUserMeta` (modify without removing), `listUserMeta` (enumerate with filter).\n\n**Returns:** `{ status: \"success\", message: \"users_meta record was deleted\" }`. No body beyond the confirmation string.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7198
7218
|
}
|
|
7199
7219
|
},
|
|
7200
7220
|
"/api/v2/tags/get": {
|
|
@@ -8556,7 +8576,7 @@
|
|
|
8556
8576
|
"post": {
|
|
8557
8577
|
"operationId": "createWebPage",
|
|
8558
8578
|
"summary": "Create a page",
|
|
8559
|
-
"description": "Create a new web page on the site. Writes live data.\n\nA WebPage is any static-ish page: the homepage (`seo_type=home`), about, contact, custom landing pages, category templates, profile templates, and search result templates. Backed by BD's `list_seo` table.\n\nPages are publicly accessible **immediately** once `content_active=1` (the default) and a valid `seo_type` is supplied — no admin action needed.\n\n**Use when:** adding a new custom landing page, about, contact, or other static-ish page. Required: `seo_type` (must match one of BD's admin-UI values — `content` is the safe default for generic pages) and `filename` (URL slug). Pages are live immediately once `content_active=1` (default).\n\n**Required:** `seo_type`, `filename`.\n\n**Parameter guidance:**\n- `seo_type` — page type identifier. Must be one of the fixed admin-UI values (invalid types produce unrenderable records). Common values: `home` (homepage replacement), `content` (generic static/landing page — BD admin default for \"new page\"), profile/search template types, etc. For a generic landing/static page, use `content`.\n- `filename` — URL slug (e.g. `about-us`), not the full URL. The public URL is `<site-domain>/<filename>`.\n- `content` — main HTML body. Supports `[widget=Name]` shortcodes AND template tokens.\n- `content_active=1` (default) — page is live; `0` = hidden.\n\n**See also:** `listWebPages` (enumerate), `updateWebPage` (modify), `createRedirect` (if replacing an existing URL, create a 301 to preserve SEO).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` including `seo_id`.\n\n\n**BD Admin UI — field label mapping:**\n\nSome field names are opaque; this is what they're called in the BD admin page-settings screens.\n\n*Display/layout toggles (integer 0/1 unless noted):*\n| Field | Admin UI label |\n|---|---|\n| `content_layout` | Full Screen Page Width |\n| `section` | Hide Banner Ad Modules |\n| `hide_header` | Hide Header |\n| `hide_footer` | Hide Footer |\n| `hide_top_right` | Hide Top Header Menu |\n| `hide_header_links` | Hide Main Menu |\n| `content_images` | Click-Enlarge Images (value: `click_to_enlarge` to enable) |\n| `show_form` | **Apply NoIndex, NoFollow** (NOT a contact-form toggle — BD repurposed this column) |\n| `disable_css_stylesheets` | Disable Default CSS Stylesheets |\n| `disable_preview_screenshot` | Disable Screenshot Preview |\n| `seo_text` | Wildcard URL Rewrite (catch-all routing) |\n\n*SEO / meta:*\n| Field | Admin UI label |\n|---|---|\n| `title` | Page Meta Title |\n| `meta_desc` | Meta Description |\n| `meta_keywords` | Meta Keywords |\n| `h1` | H1 Heading |\n| `h2` | H2 Heading |\n\n*Social (Open Graph):*\n| Field | Admin UI label |\n|---|---|\n| `facebook_title` | Social Media Title |\n| `facebook_desc` | Social Media Description |\n| `facebook_image` | Social Media Shared Image (≥200×200px) |\n\nTemplate tokens: `title`, `meta_desc`, `meta_keywords`, `h1`, `h2` all support `%%%website_name%%%`, `%industry%`, `%profession%` (expanded at render time).\n\n**Hero section (optional banner rendered above page content):** toggled via `enable_hero_section` (`0`=off, `1`=all devices, `2`=hide on mobile). The full hero config spans ~23 fields: `hero_image` (external URLs supported natively — no `auto_image_import` needed), `hero_background_image_size`, `hero_content_overlay_color` (RGB format ONLY, e.g. `rgb(0,0,0)` — hex not accepted), `hero_content_overlay_opacity`, `hero_top_padding`/`hero_bottom_padding`, `hero_column_width`, `hero_alignment`, H1 styling (`h1_font_color`/`h1_font_size`/`h1_font_weight`), H2 styling (`h2_font_color`/`h2_font_size`/`h2_font_weight`), additional content styling (`hero_content_font_color`/`hero_content_font_size`/`hero_section_content`), CTA (`hero_link_url`/`hero_link_text`/`hero_link_target_blank`/`hero_link_size`/`hero_link_color`), and `hero_hide_banner_ad` to suppress the site-wide Below Header Banner Ad on this page. All color fields require RGB format. `enable_hero_section=0` is a master kill-switch — other hero_* values remain stored but are not rendered. The H1/H2 TEXT itself comes from the page's top-level `h1` and `h2` fields; the `h1_*`/`h2_*` here control ONLY hero styling. **Homepage:** the homepage record (`seo_type=home`, typically `seo_id=1`) cannot be CREATED via API — it's system-seeded. For homepage edits use `updateWebPage` with the existing `seo_id`. **Hero fields do NOT apply to the homepage.** The homepage template ignores `enable_hero_section` and all `hero_*`/`h1_*`/`h2_*` fields — BD accepts and stores them on the record, but they never render. Skip hero fields entirely when updating the homepage.\n\n**Hero safe-defaults — ALWAYS apply when `enable_hero_section=1` or `2` and the agent is the one enabling the hero** (unless the user explicitly overrides a value). These defaults ensure text is readable over any background image:\n- `h1_font_color=\"rgb(255,255,255)\"` — white H1 readable over most hero images\n- `h2_font_color=\"rgb(255,255,255)\"` — matching white H2\n- `hero_content_overlay_color=\"rgb(0,0,0)\"` — black overlay layer\n- `hero_content_overlay_opacity=\"0.5\"` — at 0.5 (admin-UI level 5 of 10), dims the background enough for white text to pop without obscuring the image\n- `hero_top_padding=\"100\"` — 100px breathing room above hero content\n- `hero_bottom_padding=\"100\"` — 100px below\n\nApplies to BOTH `seo_type=content` and `seo_type=profile_search_results` pages. Universal readability rule.\n\n**Cache refresh REQUIRED after any hero create/update:** Hero changes do NOT reflect on the public URL until the site cache is refreshed. After ANY `createWebPage` or `updateWebPage` that touches hero fields (`enable_hero_section`, any `hero_*`, `h1_font_*`, `h2_font_*`), call `refreshSiteCache` immediately. Without the refresh, the admin dashboard will show the changes but visitors will see stale hero markup until BD's next scheduled cache cycle.\n\n**users_meta update workaround — CRITICAL for updates.** BD's `list_seo` table mixes direct columns with EAV-stored values in `users_meta`. On CREATE, `createWebPage` writes all fields correctly. On UPDATE, `updateWebPage` ONLY writes the direct columns — these 18 fields get silently ignored by the update path and must be written via `updateUserMeta` / `createUserMeta` instead: `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`. Workflow per field: (1) `listUserMeta` filter by `database=list_seo`, `database_id=<seo_id>`, `key=<field>` to find the existing `meta_id`; (2) exists → `updateUserMeta(meta_id, value=...)`; (3) missing → `createUserMeta(database=list_seo, database_id=<seo_id>, key=<field>, value=<new value>)`. Reads merge automatically via `getWebPage`/`listWebPages` — you only need the workaround for WRITES. On `deleteWebPage`, also delete the corresponding users_meta rows (filter by the deleted `seo_id`) to prevent orphans.\n\n**Hero image sourcing for agents:** never use random-image placeholders (picsum.photos, lorempixel, placekitten) — those change per page load and look broken to real visitors. Pick a content-relevant stock photo from Pexels (free license, no attribution required) via a search term derived from the page topic. Use the LARGE variant URL (Pexels provides `?auto=compress&cs=tinysrgb&w=1800` as a query string on the images hostname) — not `original`, which is often 5000+px and too heavy for a hero banner. If the user supplies their own image URL, use that.\n\n**Member Search Results SEO pages (`seo_type=profile_search_results`) — thin-content remedy workflow:** BD auto-generates dynamic search-result pages for every valid combination of location + category on the site (e.g. `california/beverly-hills/plumbers`). Google often penalizes these when they return only 1–2 members (thin content). The remedy is to create a STATIC `list_seo` record with `seo_type=profile_search_results`, `filename=<the exact URL slug>`, and `content=<unique SEO copy>` (intro paragraph, local context, FAQ, etc.) — that static record then overrides the dynamic rendering and the custom copy renders alongside the live results.\n\n**CRITICAL — `filename` MUST be a real location/category slug BD's dynamic router recognizes.** The `profile_search_results` static page works by OVERRIDING an existing dynamic search URL. If the `filename` does NOT correspond to a valid BD dynamic URL built from actual country/state/city/top_category/sub_category slugs on THIS site, **the public URL will return HTTP 404 even though the `list_seo` record exists with `content_active=1`**. BD has no dynamic page to override, so nothing renders. Arbitrary / made-up / pattern-generator / test slugs like `foo-bar-baz`, `my-cool-page`, or `hero-test-page` WILL NOT render as `profile_search_results` pages — live-verified on 2026-04-19. Every segment of the slug must come from a verified live lookup: \n - country segment (optional left-parent): `listCountries` → lowercase `country_name` with spaces → hyphens\n - state segment: `listStates` → `state_filename`\n - city segment: `listCities` → `city_filename`\n - top-category segment: `listTopCategories` → `filename`\n - sub-category segment: `listSubCategories` → `filename`\nDo NOT construct `profile_search_results` slugs from arbitrary strings. If the user wants a static page at an arbitrary URL, use `seo_type=content` instead (content pages create their own route and render at any `filename`).\n\n*URL slug construction (the `filename` field, NO leading slash):* segments use hierarchy order and any left-parent is droppable to broaden the match. Always concatenate with `/` separators:\n - Fullest: `country/state/city/top_cat/sub_cat`\n - Common: `state/city/top_cat/sub_cat` (when site is single-country)\n - `city/top_cat/sub_cat`, `top_cat/sub_cat`, `city`, `state`, `top_cat`, etc.\n\n*Where each segment comes from:*\n - `country` segment: NOT a stored slug — derive from `list_countries.country_name` (via `listCountries`) by lowercasing and replacing spaces with hyphens (e.g. `\"United States\"` → `united-states`)\n - `state` segment: `location_states.state_filename` (via `listStates`)\n - `city` segment: `location_cities.city_filename` (via `listCities`)\n - `top_cat` segment: top category's `filename` (via `listTopCategories`)\n - `sub_cat` segment: sub-category's `filename` (via `listSubCategories`)\n\n*Agent workflow for \"add SEO to [category] in [location] page\":*\n 1. Resolve each named input to its slug via the relevant list endpoint (`listCities`, `listStates`, `listTopCategories`, `listSubCategories`) filtering by the full/human name field — exact-match `=` is reliable for these.\n 2. For ambiguous requests (e.g. user says \"Beverly Hills plumbers\" — could be `beverly-hills/plumbers` OR `california/beverly-hills/plumbers`), ask the user which URL variant they want UNLESS they've explicitly requested bulk/pattern-based updates.\n 3. Check for an existing `list_seo` record at that slug: `listWebPages` with `property=filename&property_value=<slug>&property_operator==`. If found → `updateWebPage`. If not → `createWebPage` with `seo_type=profile_search_results`, `filename=<slug>`, `content=<SEO HTML>`. **Always run the check-first step — BD does NOT reject duplicate `filename` values. If you skip the check and the page already exists, BD silently creates a second row with its own `seo_id`; both records will exist, and which one wins at render time is undefined. Duplicates orphan silently, no warning.**\n 4. On create, **required defaults** for `profile_search_results` pages (unless user explicitly overrides):\n - `seo_type=profile_search_results`\n - `content_active=1`\n - `custom_html_placement=4` (Below Body Content — safest for boilerplate SEO intro without disrupting the live member UI)\n - `form_name=\"Member Profile Page\"` (sidebar — one of the 5 Master Default Sidebars; always available on every site)\n - `menu_layout=3` (Left Slim — sidebar position)\n - `date_updated=<current YYYYMMDDHHmmss>` — set on EVERY create and update (BD does not auto-populate; blank leaves admin UI showing no update date)\n - `updated_by` — optional but recommended, e.g. `\"AI Agent\"` or `\"API\"` for audit trail\n - **If user requests a different sidebar and it is NOT in the 5 master defaults OR `listSidebars` customs → ask:** \"That sidebar isn't available on this site. OK to use `Member Profile Page` (default) instead, or would you like to pick from [list of available]?\"\n 5. **MUST auto-generate SEO-optimized meta for the specific location+category combo** — don't leave these blank on a search-results SEO page, that defeats the whole purpose. Agent populates the following from the human names (not slugs), using natural \"in [city]\" / \"[city] [category] near me\" / \"best [category] in [location]\" phrasing, respecting each field's char budget, and VARYING Title vs Social Title so social platforms show different copy than the Google snippet:\n - `title` — Page Meta Title. 50–60 chars ideal, ≤70 hard max. Format: `\"[Top Sub-category or Top category] in [City], [State] | [Site Name]\"` or similar. BD stores the value verbatim — Google/Bing truncate at ~55–60 chars in the SERP snippet, so keep the important words in the first 55. Pre-truncate client-side if you want precise control.\n - `meta_desc` — Meta Description. 150–160 chars ideal, ≤170 max. 1–2 sentence pitch naming the location and category, with a CTA.\n - `meta_keywords` — comma-separated, ~200 chars. Low SEO weight today but fill anyway: `\"[category] [city], [sub-cat] [city], [category] near me, [city] [state] [category]\"`.\n - `facebook_title` — Open Graph title. 55–60 chars ideal. Should differ from `title` — more conversational for social shares.\n - `facebook_desc` — Open Graph description. 110–125 chars ideal. Shorter than `meta_desc`, punchier for social feeds.\n - **DO NOT auto-set `facebook_image`** — requires an uploaded asset from the customer.\n 6. **h1/h2 double-render trap:** if the hero section is enabled (`enable_hero_section=1` or `2`), the page's `h1` and `h2` text fields render inside the hero banner. If your `content` HTML ALSO contains an `<h1>` or `<h2>`, the page renders BOTH — creating duplicate headings (bad for SEO). Safe rule: if you put `<h1>`/`<h2>` inside `content`, leave the page's `h1`/`h2` fields empty; if you want the hero to show the heading, set `h1`/`h2` on the record and don't repeat it in `content`.\n 7. `custom_html_placement` is only meaningful on `profile_search_results` (and later `data_category`) page types — ignored on regular `content` pages.\n 8. **Country-only slug caveat (live-verified):** `filename=<country_slug>` (e.g. `united-states` by itself) stores as a `list_seo` record but **does NOT render a public URL** — BD has no standalone country-level dynamic search route, so the slug 404s. The country slug is only useful as a LEFT-PARENT PREFIX to a longer slug (e.g. `united-states/california/los-angeles/plumbers`). Country-alone works fine for `content`-type pages via `filename`; the 404 is specific to `profile_search_results`.\n\nBD handles the dynamic-to-static takeover automatically: once a `list_seo` record exists with a matching slug and `content_active=1`, it overrides the dynamic page for that URL. Millions of dynamic search URLs can exist on a site without any `list_seo` rows — they only enter `list_seo` when an admin/API explicitly converts them to static pages.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._",
|
|
8579
|
+
"description": "Create a new web page on the site. Writes live data.\n\nA WebPage is any static-ish page: the homepage (`seo_type=home`), about, contact, custom landing pages, category templates, profile templates, and search result templates. Backed by BD's `list_seo` table.\n\nPages are publicly accessible **immediately** once `content_active=1` (the default) and a valid `seo_type` is supplied — no admin action needed.\n\n**Use when:** adding a new custom landing page, about, contact, or other static-ish page. Required: `seo_type` (must match one of BD's admin-UI values — `content` is the safe default for generic pages) and `filename` (URL slug). Pages are live immediately once `content_active=1` (default).\n\n**Required:** `seo_type`, `filename`.\n\n**Parameter guidance:**\n- `seo_type` — page type identifier. Must be one of the fixed admin-UI values (invalid types produce unrenderable records). Common values: `home` (homepage replacement), `content` (generic static/landing page — BD admin default for \"new page\"), profile/search template types, etc. For a generic landing/static page, use `content`.\n- `filename` — URL slug (e.g. `about-us`), not the full URL. The public URL is `<site-domain>/<filename>`.\n- `content` — main HTML body. Supports `[widget=Name]` shortcodes AND template tokens.\n- `content_active=1` (default) — page is live; `0` = hidden.\n\n**See also:** `listWebPages` (enumerate), `updateWebPage` (modify), `createRedirect` (if replacing an existing URL, create a 301 to preserve SEO).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` including `seo_id`.\n\n\n**BD Admin UI — field label mapping:**\n\nSome field names are opaque; this is what they're called in the BD admin page-settings screens.\n\n*Display/layout toggles (integer 0/1 unless noted):*\n| Field | Admin UI label |\n|---|---|\n| `content_layout` | Full Screen Page Width |\n| `section` | Hide Banner Ad Modules |\n| `hide_header` | Hide Header |\n| `hide_footer` | Hide Footer |\n| `hide_top_right` | Hide Top Header Menu |\n| `hide_header_links` | Hide Main Menu |\n| `content_images` | Click-Enlarge Images (value: `click_to_enlarge` to enable) |\n| `show_form` | **Apply NoIndex, NoFollow** (NOT a contact-form toggle — BD repurposed this column) |\n| `disable_css_stylesheets` | Disable Default CSS Stylesheets |\n| `disable_preview_screenshot` | Disable Screenshot Preview |\n| `seo_text` | Wildcard URL Rewrite (catch-all routing) |\n\n*SEO / meta:*\n| Field | Admin UI label |\n|---|---|\n| `title` | Page Meta Title |\n| `meta_desc` | Meta Description |\n| `meta_keywords` | Meta Keywords |\n| `h1` | H1 Heading |\n| `h2` | H2 Heading |\n\n*Social (Open Graph):*\n| Field | Admin UI label |\n|---|---|\n| `facebook_title` | Social Media Title |\n| `facebook_desc` | Social Media Description |\n| `facebook_image` | Social Media Shared Image (≥200×200px) |\n\nTemplate tokens: `title`, `meta_desc`, `meta_keywords`, `h1`, `h2` all support `%%%website_name%%%`, `%industry%`, `%profession%` (expanded at render time).\n\n**Hero section (optional banner rendered above page content):** toggled via `enable_hero_section` (`0`=off, `1`=all devices, `2`=hide on mobile). The full hero config spans ~23 fields: `hero_image` (external URLs supported natively — no `auto_image_import` needed), `hero_background_image_size`, `hero_content_overlay_color` (RGB format ONLY, e.g. `rgb(0,0,0)` — hex not accepted), `hero_content_overlay_opacity`, `hero_top_padding`/`hero_bottom_padding`, `hero_column_width`, `hero_alignment`, H1 styling (`h1_font_color`/`h1_font_size`/`h1_font_weight`), H2 styling (`h2_font_color`/`h2_font_size`/`h2_font_weight`), additional content styling (`hero_content_font_color`/`hero_content_font_size`/`hero_section_content`), CTA (`hero_link_url`/`hero_link_text`/`hero_link_target_blank`/`hero_link_size`/`hero_link_color`), and `hero_hide_banner_ad` to suppress the site-wide Below Header Banner Ad on this page. All color fields require RGB format. `enable_hero_section=0` is a master kill-switch — other hero_* values remain stored but are not rendered. The H1/H2 TEXT itself comes from the page's top-level `h1` and `h2` fields; the `h1_*`/`h2_*` here control ONLY hero styling. **Homepage:** the homepage record (`seo_type=home`, typically `seo_id=1`) cannot be CREATED via API — it's system-seeded. For homepage edits use `updateWebPage` with the existing `seo_id`. **Hero fields do NOT apply to the homepage.** The homepage template ignores `enable_hero_section` and all `hero_*`/`h1_*`/`h2_*` fields — BD accepts and stores them on the record, but they never render. Skip hero fields entirely when updating the homepage.\n\n**Hero safe-defaults — ALWAYS apply when `enable_hero_section=1` or `2` and the agent is the one enabling the hero** (unless the user explicitly overrides a value). These defaults ensure text is readable over any background image:\n- `h1_font_color=\"rgb(255,255,255)\"` — white H1 readable over most hero images\n- `h2_font_color=\"rgb(255,255,255)\"` — matching white H2\n- `hero_content_overlay_color=\"rgb(0,0,0)\"` — black overlay layer\n- `hero_content_overlay_opacity=\"0.5\"` — at 0.5 (admin-UI level 5 of 10), dims the background enough for white text to pop without obscuring the image. **EAV-STORED — `createWebPage` writes this correctly, but `updateWebPage` silently drops it. On updates, write it via `updateUserMeta`/`createUserMeta` with `database=list_seo`. See the EAV workaround section below.**\n- `hero_top_padding=\"100\"` — 100px breathing room above hero content\n- `hero_bottom_padding=\"100\"` — 100px below\n\nApplies to BOTH `seo_type=content` and `seo_type=profile_search_results` pages. Universal readability rule.\n\n**Cache refresh REQUIRED after any hero create/update:** Hero changes do NOT reflect on the public URL until the site cache is refreshed. After ANY `createWebPage` or `updateWebPage` that touches hero fields (`enable_hero_section`, any `hero_*`, `h1_font_*`, `h2_font_*`), call `refreshSiteCache` immediately. Without the refresh, the admin dashboard will show the changes but visitors will see stale hero markup until BD's next scheduled cache cycle.\n\n**users_meta update workaround — CRITICAL for updates.** BD's `list_seo` table mixes direct columns with EAV-stored values in `users_meta`. On CREATE, `createWebPage` writes all fields correctly. On UPDATE, `updateWebPage` ONLY writes the direct columns — these 18 fields get silently ignored by the update path and must be written via `updateUserMeta` / `createUserMeta` instead: `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`. Workflow per field: (1) `listUserMeta` filter by `database=list_seo`, `database_id=<seo_id>`, `key=<field>` to find the existing `meta_id`; (2) exists → `updateUserMeta(meta_id, value=...)`; (3) missing → `createUserMeta(database=list_seo, database_id=<seo_id>, key=<field>, value=<new value>)`. Reads merge automatically via `getWebPage`/`listWebPages` — you only need the workaround for WRITES. On `deleteWebPage`, also delete the corresponding users_meta rows (filter by the deleted `seo_id`) to prevent orphans.\n\n**Hero image sourcing for agents:** never use random-image placeholders (picsum.photos, lorempixel, placekitten) — those change per page load and look broken to real visitors. Pick a content-relevant stock photo from Pexels (free license, no attribution required) via a search term derived from the page topic. Use the LARGE variant URL (Pexels provides `?auto=compress&cs=tinysrgb&w=1800` as a query string on the images hostname) — not `original`, which is often 5000+px and too heavy for a hero banner. If the user supplies their own image URL, use that.\n\n**Member Search Results SEO pages (`seo_type=profile_search_results`) — thin-content remedy workflow:** BD auto-generates dynamic search-result pages for every valid combination of location + category on the site (e.g. `california/beverly-hills/plumbers`). Google often penalizes these when they return only 1–2 members (thin content). The remedy is to create a STATIC `list_seo` record with `seo_type=profile_search_results`, `filename=<the exact URL slug>`, and `content=<unique SEO copy>` (intro paragraph, local context, FAQ, etc.) — that static record then overrides the dynamic rendering and the custom copy renders alongside the live results.\n\n**CRITICAL — `filename` MUST be a real location/category slug BD's dynamic router recognizes.** The `profile_search_results` static page works by OVERRIDING an existing dynamic search URL. If the `filename` does NOT correspond to a valid BD dynamic URL built from actual country/state/city/top_category/sub_category slugs on THIS site, **the public URL will return HTTP 404 even though the `list_seo` record exists with `content_active=1`**. BD has no dynamic page to override, so nothing renders. Arbitrary / made-up / pattern-generator / test slugs like `foo-bar-baz`, `my-cool-page`, or `hero-test-page` WILL NOT render as `profile_search_results` pages — live-verified on 2026-04-19. Every segment of the slug must come from a verified live lookup: \n - country segment (optional left-parent): `listCountries` → lowercase `country_name` with spaces → hyphens\n - state segment: `listStates` → `state_filename`\n - city segment: `listCities` → `city_filename`\n - top-category segment: `listTopCategories` → `filename`\n - sub-category segment: `listSubCategories` → `filename`\nDo NOT construct `profile_search_results` slugs from arbitrary strings. If the user wants a static page at an arbitrary URL, use `seo_type=content` instead (content pages create their own route and render at any `filename`).\n\n*URL slug construction (the `filename` field, NO leading slash):* segments use hierarchy order and any left-parent is droppable to broaden the match. Always concatenate with `/` separators:\n - Fullest: `country/state/city/top_cat/sub_cat`\n - Common: `state/city/top_cat/sub_cat` (when site is single-country)\n - `city/top_cat/sub_cat`, `top_cat/sub_cat`, `city`, `state`, `top_cat`, etc.\n\n*Where each segment comes from:*\n - `country` segment: NOT a stored slug — derive from `list_countries.country_name` (via `listCountries`) by lowercasing and replacing spaces with hyphens (e.g. `\"United States\"` → `united-states`)\n - `state` segment: `location_states.state_filename` (via `listStates`)\n - `city` segment: `location_cities.city_filename` (via `listCities`)\n - `top_cat` segment: top category's `filename` (via `listTopCategories`)\n - `sub_cat` segment: sub-category's `filename` (via `listSubCategories`)\n\n*Agent workflow for \"add SEO to [category] in [location] page\":*\n 1. Resolve each named input to its slug via the relevant list endpoint (`listCities`, `listStates`, `listTopCategories`, `listSubCategories`) filtering by the full/human name field — exact-match `=` is reliable for these.\n 2. For ambiguous requests (e.g. user says \"Beverly Hills plumbers\" — could be `beverly-hills/plumbers` OR `california/beverly-hills/plumbers`), ask the user which URL variant they want UNLESS they've explicitly requested bulk/pattern-based updates.\n 3. Check for an existing `list_seo` record at that slug: `listWebPages` with `property=filename&property_value=<slug>&property_operator==`. If found → `updateWebPage`. If not → `createWebPage` with `seo_type=profile_search_results`, `filename=<slug>`, `content=<SEO HTML>`. **Always run the check-first step — BD does NOT reject duplicate `filename` values. If you skip the check and the page already exists, BD silently creates a second row with its own `seo_id`; both records will exist, and which one wins at render time is undefined. Duplicates orphan silently, no warning.**\n 4. On create, **required defaults** for `profile_search_results` pages (unless user explicitly overrides):\n - `seo_type=profile_search_results`\n - `content_active=1`\n - `custom_html_placement=4` (Below Body Content — safest for boilerplate SEO intro without disrupting the live member UI)\n - `form_name=\"Member Profile Page\"` (sidebar — one of the 5 Master Default Sidebars; always available on every site)\n - `menu_layout=3` (Left Slim — sidebar position)\n - `date_updated=<current YYYYMMDDHHmmss>` — set on EVERY create and update (BD does not auto-populate; blank leaves admin UI showing no update date)\n - `updated_by` — optional but recommended, e.g. `\"AI Agent\"` or `\"API\"` for audit trail\n - **If user requests a different sidebar and it is NOT in the 5 master defaults OR `listSidebars` customs → ask:** \"That sidebar isn't available on this site. OK to use `Member Profile Page` (default) instead, or would you like to pick from [list of available]?\"\n 5. **MUST auto-generate SEO-optimized meta for the specific location+category combo** — don't leave these blank on a search-results SEO page, that defeats the whole purpose. Agent populates the following from the human names (not slugs), using natural \"in [city]\" / \"[city] [category] near me\" / \"best [category] in [location]\" phrasing, respecting each field's char budget, and VARYING Title vs Social Title so social platforms show different copy than the Google snippet:\n - `title` — Page Meta Title. 50–60 chars ideal, ≤70 hard max. Format: `\"[Top Sub-category or Top category] in [City], [State] | [Site Name]\"` or similar. BD stores the value verbatim — Google/Bing truncate at ~55–60 chars in the SERP snippet, so keep the important words in the first 55. Pre-truncate client-side if you want precise control.\n - `meta_desc` — Meta Description. 150–160 chars ideal, ≤170 max. 1–2 sentence pitch naming the location and category, with a CTA.\n - `meta_keywords` — comma-separated, ~200 chars. Low SEO weight today but fill anyway: `\"[category] [city], [sub-cat] [city], [category] near me, [city] [state] [category]\"`.\n - `facebook_title` — Open Graph title. 55–60 chars ideal. Should differ from `title` — more conversational for social shares.\n - `facebook_desc` — Open Graph description. 110–125 chars ideal. Shorter than `meta_desc`, punchier for social feeds.\n - **DO NOT auto-set `facebook_image`** — requires an uploaded asset from the customer.\n 6. **h1/h2 double-render trap:** if the hero section is enabled (`enable_hero_section=1` or `2`), the page's `h1` and `h2` text fields render inside the hero banner. If your `content` HTML ALSO contains an `<h1>` or `<h2>`, the page renders BOTH — creating duplicate headings (bad for SEO). Safe rule: if you put `<h1>`/`<h2>` inside `content`, leave the page's `h1`/`h2` fields empty; if you want the hero to show the heading, set `h1`/`h2` on the record and don't repeat it in `content`.\n 7. `custom_html_placement` is only meaningful on `profile_search_results` (and later `data_category`) page types — ignored on regular `content` pages.\n 8. **Country-only slug caveat (live-verified):** `filename=<country_slug>` (e.g. `united-states` by itself) stores as a `list_seo` record but **does NOT render a public URL** — BD has no standalone country-level dynamic search route, so the slug 404s. The country slug is only useful as a LEFT-PARENT PREFIX to a longer slug (e.g. `united-states/california/los-angeles/plumbers`). Country-alone works fine for `content`-type pages via `filename`; the 404 is specific to `profile_search_results`.\n\nBD handles the dynamic-to-static takeover automatically: once a `list_seo` record exists with a matching slug and `content_active=1`, it overrides the dynamic page for that URL. Millions of dynamic search URLs can exist on a site without any `list_seo` rows — they only enter `list_seo` when an admin/API explicitly converts them to static pages.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._",
|
|
8560
8580
|
"tags": [
|
|
8561
8581
|
"Pages"
|
|
8562
8582
|
],
|
|
@@ -8568,7 +8588,8 @@
|
|
|
8568
8588
|
"type": "object",
|
|
8569
8589
|
"required": [
|
|
8570
8590
|
"seo_type",
|
|
8571
|
-
"filename"
|
|
8591
|
+
"filename",
|
|
8592
|
+
"date_updated"
|
|
8572
8593
|
],
|
|
8573
8594
|
"properties": {
|
|
8574
8595
|
"seo_type": {
|
|
@@ -8581,7 +8602,7 @@
|
|
|
8581
8602
|
"password_retrieval_page",
|
|
8582
8603
|
"unsubscribed"
|
|
8583
8604
|
],
|
|
8584
|
-
"description": "Page type identifier. These are the values BD customers can choose from in admin
|
|
8605
|
+
"description": "Page type identifier. These are the values BD customers can choose from in admin:\n content = Single Web Page (USE THIS for custom/landing/static pages — it is the default)\n data_category = Post Search Results\n profile_search_results = Member Search Results\n custom_widget_page = Custom Widget as Web Page\n password_retrieval_page = Password Retrieval Page\n unsubscribed = Unsubscribed Page\nWhen a user asks for a \"landing page\", \"static page\", \"about page\", \"contact page\", or any generic custom page, always use \"content\".\nNote: the underlying BD system has additional internal seo_type values (home, profile, payment, etc.) that are system-seeded and should NOT be created via API — customers never have a reason to call createPage with those."
|
|
8585
8606
|
},
|
|
8586
8607
|
"filename": {
|
|
8587
8608
|
"type": "string",
|
|
@@ -8667,7 +8688,7 @@
|
|
|
8667
8688
|
3,
|
|
8668
8689
|
4
|
|
8669
8690
|
],
|
|
8670
|
-
"description": "Sidebar position and width (integer). Only has an effect when the page has a sidebar configured via `form_name` — ignored on pages without a sidebar
|
|
8691
|
+
"description": "Sidebar position and width (integer). Only has an effect when the page has a sidebar configured via `form_name` — ignored on pages without a sidebar.\n 1 = Left Wide (sidebar on the left, wide column) — BD default when unspecified\n 2 = Right Wide (sidebar on the right, wide column)\n 3 = Left Slim (sidebar on the left, narrow column)\n 4 = Right Slim (sidebar on the right, narrow column)\nNote the ordering is NOT sequential by side — left positions are 1 and 3, right positions are 2 and 4. Despite the field name, this is the SIDEBAR position setting, not a navigation menu layout.\n**Default on create for `profile_search_results` pages:** `3` (Left Slim). For regular `content` pages, omit unless user specifies — BD defaults to 1 (Left Wide)."
|
|
8671
8692
|
},
|
|
8672
8693
|
"show_form": {
|
|
8673
8694
|
"type": "integer",
|
|
@@ -8752,7 +8773,7 @@
|
|
|
8752
8773
|
"custom_html_placement": {
|
|
8753
8774
|
"type": "string",
|
|
8754
8775
|
"enum": ["0", "1", "2", "3", "4"],
|
|
8755
|
-
"description": "Where to render the page's custom SEO content (`content` HTML) in relation to the dynamic search results, on `seo_type=profile_search_results` pages. Only meaningful for search-result static pages (and later `seo_type=data_category`) — ignored on regular `content` pages
|
|
8776
|
+
"description": "Where to render the page's custom SEO content (`content` HTML) in relation to the dynamic search results, on `seo_type=profile_search_results` pages. Only meaningful for search-result static pages (and later `seo_type=data_category`) — ignored on regular `content` pages.\n 0 = Inside Tab (content + member results render in separate nav tabs)\n 1 = Above Member Results (within the results container; respects sidebar width)\n 2 = Below Member Results (within the results container)\n 3 = Above Body Content (full page container width — spans above sidebar + results)\n 4 = Below Body Content (full page container width — below sidebar + results) ← **recommended default for AI-generated SEO pages**\nFor boilerplate SEO intro paragraphs / FAQ / local copy aimed at bolstering thin pages, `4` is the safest default because it renders full-width below the live results without disrupting the primary member-facing UX."
|
|
8756
8777
|
},
|
|
8757
8778
|
"enable_hero_section": {
|
|
8758
8779
|
"type": "string",
|
|
@@ -8780,7 +8801,7 @@
|
|
|
8780
8801
|
"hero_content_overlay_opacity": {
|
|
8781
8802
|
"type": "string",
|
|
8782
8803
|
"enum": ["0.0", "0.1", "0.2", "0.3", "0.4", "0.5", "0.6", "0.7", "0.8", "0.9", "1"],
|
|
8783
|
-
"description": "Opacity of the `hero_content_overlay_color` layer, in 0.1 increments from `0.0` (fully transparent / invisible) to `1` (fully opaque). Admin UI labels these as 0–10 (10 = fully opaque). Default in admin-UI creation is `0.4`. **
|
|
8804
|
+
"description": "Opacity of the `hero_content_overlay_color` layer, in 0.1 increments from `0.0` (fully transparent / invisible) to `1` (fully opaque). Admin UI labels these as 0–10 (10 = fully opaque). Default in admin-UI creation is `0.4`. **EAV-STORED FIELD (one of the 18 list_seo fields stored in `users_meta`, not as a direct column):** `createWebPage` seeds this correctly, but `updateWebPage` silently ignores it. To update on an existing page, call `updateUserMeta` (or `createUserMeta` if no row exists yet) with `database=list_seo`, `database_id=<seo_id>`, `key=hero_content_overlay_opacity`, `value=<new value>`, then `refreshSiteCache` to re-render. Per v6.7.1 safety rule, every `updateUserMeta`/`deleteUserMeta` call must also carry `database` + `database_id`."
|
|
8784
8805
|
},
|
|
8785
8806
|
"hero_top_padding": {
|
|
8786
8807
|
"type": "string",
|
|
@@ -8910,7 +8931,8 @@
|
|
|
8910
8931
|
"schema": {
|
|
8911
8932
|
"type": "object",
|
|
8912
8933
|
"required": [
|
|
8913
|
-
"seo_id"
|
|
8934
|
+
"seo_id",
|
|
8935
|
+
"date_updated"
|
|
8914
8936
|
],
|
|
8915
8937
|
"properties": {
|
|
8916
8938
|
"seo_id": {
|
|
@@ -8928,7 +8950,7 @@
|
|
|
8928
8950
|
"unsubscribed",
|
|
8929
8951
|
"home"
|
|
8930
8952
|
],
|
|
8931
|
-
"description": "Page type identifier. On update, safest to OMIT this field unless intentionally changing it (most seo_type changes are destructive). Values
|
|
8953
|
+
"description": "Page type identifier. On update, safest to OMIT this field unless intentionally changing it (most seo_type changes are destructive). Values:\n content = Single Web Page (generic static/landing page)\n data_category = Post Search Results\n profile_search_results = Member Search Results\n custom_widget_page = Custom Widget as Web Page\n password_retrieval_page = Password Retrieval Page\n unsubscribed = Unsubscribed Page\n home = Homepage (system-seeded; included here so an update round-trip of the existing homepage record passes the enum check)"
|
|
8932
8954
|
},
|
|
8933
8955
|
"filename": {
|
|
8934
8956
|
"type": "string",
|
|
@@ -9014,7 +9036,7 @@
|
|
|
9014
9036
|
3,
|
|
9015
9037
|
4
|
|
9016
9038
|
],
|
|
9017
|
-
"description": "Sidebar position and width (integer). Only has an effect when the page has a sidebar configured via `form_name` — ignored on pages without a sidebar
|
|
9039
|
+
"description": "Sidebar position and width (integer). Only has an effect when the page has a sidebar configured via `form_name` — ignored on pages without a sidebar.\n 1 = Left Wide (sidebar on the left, wide column) — BD default when unspecified\n 2 = Right Wide (sidebar on the right, wide column)\n 3 = Left Slim (sidebar on the left, narrow column)\n 4 = Right Slim (sidebar on the right, narrow column)\nNote the ordering is NOT sequential by side — left positions are 1 and 3, right positions are 2 and 4. Despite the field name, this is the SIDEBAR position setting, not a navigation menu layout.\n**Default on create for `profile_search_results` pages:** `3` (Left Slim). For regular `content` pages, omit unless user specifies — BD defaults to 1 (Left Wide)."
|
|
9018
9040
|
},
|
|
9019
9041
|
"show_form": {
|
|
9020
9042
|
"type": "integer",
|
|
@@ -9099,7 +9121,7 @@
|
|
|
9099
9121
|
"custom_html_placement": {
|
|
9100
9122
|
"type": "string",
|
|
9101
9123
|
"enum": ["0", "1", "2", "3", "4"],
|
|
9102
|
-
"description": "Where to render the page's custom SEO content (`content` HTML) in relation to the dynamic search results, on `seo_type=profile_search_results` pages. Only meaningful for search-result static pages (and later `seo_type=data_category`) — ignored on regular `content` pages
|
|
9124
|
+
"description": "Where to render the page's custom SEO content (`content` HTML) in relation to the dynamic search results, on `seo_type=profile_search_results` pages. Only meaningful for search-result static pages (and later `seo_type=data_category`) — ignored on regular `content` pages.\n 0 = Inside Tab (content + member results render in separate nav tabs)\n 1 = Above Member Results (within the results container; respects sidebar width)\n 2 = Below Member Results (within the results container)\n 3 = Above Body Content (full page container width — spans above sidebar + results)\n 4 = Below Body Content (full page container width — below sidebar + results) ← **recommended default for AI-generated SEO pages**\nFor boilerplate SEO intro paragraphs / FAQ / local copy aimed at bolstering thin pages, `4` is the safest default because it renders full-width below the live results without disrupting the primary member-facing UX."
|
|
9103
9125
|
},
|
|
9104
9126
|
"enable_hero_section": {
|
|
9105
9127
|
"type": "string",
|
|
@@ -9127,7 +9149,7 @@
|
|
|
9127
9149
|
"hero_content_overlay_opacity": {
|
|
9128
9150
|
"type": "string",
|
|
9129
9151
|
"enum": ["0.0", "0.1", "0.2", "0.3", "0.4", "0.5", "0.6", "0.7", "0.8", "0.9", "1"],
|
|
9130
|
-
"description": "Opacity of the `hero_content_overlay_color` layer, in 0.1 increments from `0.0` (fully transparent / invisible) to `1` (fully opaque). Admin UI labels these as 0–10 (10 = fully opaque). Default in admin-UI creation is `0.4`. **
|
|
9152
|
+
"description": "Opacity of the `hero_content_overlay_color` layer, in 0.1 increments from `0.0` (fully transparent / invisible) to `1` (fully opaque). Admin UI labels these as 0–10 (10 = fully opaque). Default in admin-UI creation is `0.4`. **EAV-STORED FIELD (one of the 18 list_seo fields stored in `users_meta`, not as a direct column):** `createWebPage` seeds this correctly, but `updateWebPage` silently ignores it. To update on an existing page, call `updateUserMeta` (or `createUserMeta` if no row exists yet) with `database=list_seo`, `database_id=<seo_id>`, `key=hero_content_overlay_opacity`, `value=<new value>`, then `refreshSiteCache` to re-render. Per v6.7.1 safety rule, every `updateUserMeta`/`deleteUserMeta` call must also carry `database` + `database_id`."
|
|
9131
9153
|
},
|
|
9132
9154
|
"hero_top_padding": {
|
|
9133
9155
|
"type": "string",
|
|
@@ -9241,7 +9263,7 @@
|
|
|
9241
9263
|
}
|
|
9242
9264
|
}
|
|
9243
9265
|
},
|
|
9244
|
-
"description": "Update an existing web page by `seo_id`. Fields omitted are untouched. Writes live data.\n\nChanges go live immediately. No cache refresh needed for most edits. If changing `filename` (URL slug), consider creating a 301 via `createRedirect` so inbound links to the old slug keep working.\n\n**Use when:** editing copy, meta tags, social-share images, or toggling layout flags (hide header/footer, full-width, etc.). Changing `filename` breaks inbound links — create a `Redirect` via `createRedirect` to preserve SEO.\n\n**Required:** `seo_id`.\n\n**Common edits:**\n- Copy/content: `content`, `h1`, `h2`, `seo_text`, `content_footer`\n- SEO: `title`, `meta_desc`, `meta_keywords`\n- Social: `facebook_title`, `facebook_desc`, `facebook_image`\n- Layout: `content_layout`, `hide_header`, `hide_footer`, etc. (see mapping below)\n- Visibility: `content_active` (1 = live, 0 = hidden)\n\n**See also:** `createWebPage` (add new), `deleteWebPage` (remove), `createRedirect` (after slug changes).\n\n**Writes live data:** immediately visible.\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n**BD Admin UI — field label mapping:**\n\nSome field names are opaque; this is what they're called in the BD admin page-settings screens.\n\n*Display/layout toggles (integer 0/1 unless noted):*\n| Field | Admin UI label |\n|---|---|\n| `content_layout` | Full Screen Page Width |\n| `section` | Hide Banner Ad Modules |\n| `hide_header` | Hide Header |\n| `hide_footer` | Hide Footer |\n| `hide_top_right` | Hide Top Header Menu |\n| `hide_header_links` | Hide Main Menu |\n| `content_images` | Click-Enlarge Images (value: `click_to_enlarge` to enable) |\n| `show_form` | **Apply NoIndex, NoFollow** (NOT a contact-form toggle — BD repurposed this column) |\n| `disable_css_stylesheets` | Disable Default CSS Stylesheets |\n| `disable_preview_screenshot` | Disable Screenshot Preview |\n| `seo_text` | Wildcard URL Rewrite (catch-all routing) |\n\n*SEO / meta:*\n| Field | Admin UI label |\n|---|---|\n| `title` | Page Meta Title |\n| `meta_desc` | Meta Description |\n| `meta_keywords` | Meta Keywords |\n| `h1` | H1 Heading |\n| `h2` | H2 Heading |\n\n*Social (Open Graph):*\n| Field | Admin UI label |\n|---|---|\n| `facebook_title` | Social Media Title |\n| `facebook_desc` | Social Media Description |\n| `facebook_image` | Social Media Shared Image (≥200×200px) |\n\nTemplate tokens: `title`, `meta_desc`, `meta_keywords`, `h1`, `h2` all support `%%%website_name%%%`, `%industry%`, `%profession%` (expanded at render time).\n\n**Hero section (optional banner rendered above page content):** toggled via `enable_hero_section` (`0`=off, `1`=all devices, `2`=hide on mobile). The full hero config spans ~23 fields: `hero_image` (external URLs supported natively — no `auto_image_import` needed), `hero_background_image_size`, `hero_content_overlay_color` (RGB format ONLY, e.g. `rgb(0,0,0)` — hex not accepted), `hero_content_overlay_opacity`, `hero_top_padding`/`hero_bottom_padding`, `hero_column_width`, `hero_alignment`, H1 styling (`h1_font_color`/`h1_font_size`/`h1_font_weight`), H2 styling (`h2_font_color`/`h2_font_size`/`h2_font_weight`), additional content styling (`hero_content_font_color`/`hero_content_font_size`/`hero_section_content`), CTA (`hero_link_url`/`hero_link_text`/`hero_link_target_blank`/`hero_link_size`/`hero_link_color`), and `hero_hide_banner_ad` to suppress the site-wide Below Header Banner Ad on this page. All color fields require RGB format. `enable_hero_section=0` is a master kill-switch — other hero_* values remain stored but are not rendered. The H1/H2 TEXT itself comes from the page's top-level `h1` and `h2` fields; the `h1_*`/`h2_*` here control ONLY hero styling. **Homepage:** the homepage record (`seo_type=home`, typically `seo_id=1`) cannot be CREATED via API — it's system-seeded. For homepage edits use `updateWebPage` with the existing `seo_id`. **Hero fields do NOT apply to the homepage.** The homepage template ignores `enable_hero_section` and all `hero_*`/`h1_*`/`h2_*` fields — BD accepts and stores them on the record, but they never render. Skip hero fields entirely when updating the homepage.\n\n**Hero safe-defaults — ALWAYS apply when `enable_hero_section=1` or `2` and the agent is the one enabling the hero** (unless the user explicitly overrides a value). These defaults ensure text is readable over any background image:\n- `h1_font_color=\"rgb(255,255,255)\"` — white H1 readable over most hero images\n- `h2_font_color=\"rgb(255,255,255)\"` — matching white H2\n- `hero_content_overlay_color=\"rgb(0,0,0)\"` — black overlay layer\n- `hero_content_overlay_opacity=\"0.5\"` — at 0.5 (admin-UI level 5 of 10), dims the background enough for white text to pop without obscuring the image\n- `hero_top_padding=\"100\"` — 100px breathing room above hero content\n- `hero_bottom_padding=\"100\"` — 100px below\n\nApplies to BOTH `seo_type=content` and `seo_type=profile_search_results` pages. Universal readability rule.\n\n**Cache refresh REQUIRED after any hero create/update:** Hero changes do NOT reflect on the public URL until the site cache is refreshed. After ANY `createWebPage` or `updateWebPage` that touches hero fields (`enable_hero_section`, any `hero_*`, `h1_font_*`, `h2_font_*`), call `refreshSiteCache` immediately. Without the refresh, the admin dashboard will show the changes but visitors will see stale hero markup until BD's next scheduled cache cycle.\n\n**users_meta update workaround — CRITICAL for updates.** BD's `list_seo` table mixes direct columns with EAV-stored values in `users_meta`. On CREATE, `createWebPage` writes all fields correctly. On UPDATE, `updateWebPage` ONLY writes the direct columns — these 18 fields get silently ignored by the update path and must be written via `updateUserMeta` / `createUserMeta` instead: `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`. Workflow per field: (1) `listUserMeta` filter by `database=list_seo`, `database_id=<seo_id>`, `key=<field>` to find the existing `meta_id`; (2) exists → `updateUserMeta(meta_id, value=...)`; (3) missing → `createUserMeta(database=list_seo, database_id=<seo_id>, key=<field>, value=<new value>)`. Reads merge automatically via `getWebPage`/`listWebPages` — you only need the workaround for WRITES. On `deleteWebPage`, also delete the corresponding users_meta rows (filter by the deleted `seo_id`) to prevent orphans.\n\n**Hero image sourcing for agents:** never use random-image placeholders (picsum.photos, lorempixel, placekitten) — those change per page load and look broken to real visitors. Pick a content-relevant stock photo from Pexels (free license, no attribution required) via a search term derived from the page topic. Use the LARGE variant URL (Pexels provides `?auto=compress&cs=tinysrgb&w=1800` as a query string on the images hostname) — not `original`, which is often 5000+px and too heavy for a hero banner. If the user supplies their own image URL, use that.\n\n**Member Search Results SEO pages (`seo_type=profile_search_results`) — thin-content remedy workflow:** BD auto-generates dynamic search-result pages for every valid combination of location + category on the site (e.g. `california/beverly-hills/plumbers`). Google often penalizes these when they return only 1–2 members (thin content). The remedy is to create a STATIC `list_seo` record with `seo_type=profile_search_results`, `filename=<the exact URL slug>`, and `content=<unique SEO copy>` (intro paragraph, local context, FAQ, etc.) — that static record then overrides the dynamic rendering and the custom copy renders alongside the live results.\n\n**CRITICAL — `filename` MUST be a real location/category slug BD's dynamic router recognizes.** The `profile_search_results` static page works by OVERRIDING an existing dynamic search URL. If the `filename` does NOT correspond to a valid BD dynamic URL built from actual country/state/city/top_category/sub_category slugs on THIS site, **the public URL will return HTTP 404 even though the `list_seo` record exists with `content_active=1`**. BD has no dynamic page to override, so nothing renders. Arbitrary / made-up / pattern-generator / test slugs like `foo-bar-baz`, `my-cool-page`, or `hero-test-page` WILL NOT render as `profile_search_results` pages — live-verified on 2026-04-19. Every segment of the slug must come from a verified live lookup: \n - country segment (optional left-parent): `listCountries` → lowercase `country_name` with spaces → hyphens\n - state segment: `listStates` → `state_filename`\n - city segment: `listCities` → `city_filename`\n - top-category segment: `listTopCategories` → `filename`\n - sub-category segment: `listSubCategories` → `filename`\nDo NOT construct `profile_search_results` slugs from arbitrary strings. If the user wants a static page at an arbitrary URL, use `seo_type=content` instead (content pages create their own route and render at any `filename`).\n\n*URL slug construction (the `filename` field, NO leading slash):* segments use hierarchy order and any left-parent is droppable to broaden the match. Always concatenate with `/` separators:\n - Fullest: `country/state/city/top_cat/sub_cat`\n - Common: `state/city/top_cat/sub_cat` (when site is single-country)\n - `city/top_cat/sub_cat`, `top_cat/sub_cat`, `city`, `state`, `top_cat`, etc.\n\n*Where each segment comes from:*\n - `country` segment: NOT a stored slug — derive from `list_countries.country_name` (via `listCountries`) by lowercasing and replacing spaces with hyphens (e.g. `\"United States\"` → `united-states`)\n - `state` segment: `location_states.state_filename` (via `listStates`)\n - `city` segment: `location_cities.city_filename` (via `listCities`)\n - `top_cat` segment: top category's `filename` (via `listTopCategories`)\n - `sub_cat` segment: sub-category's `filename` (via `listSubCategories`)\n\n*Agent workflow for \"add SEO to [category] in [location] page\":*\n 1. Resolve each named input to its slug via the relevant list endpoint (`listCities`, `listStates`, `listTopCategories`, `listSubCategories`) filtering by the full/human name field — exact-match `=` is reliable for these.\n 2. For ambiguous requests (e.g. user says \"Beverly Hills plumbers\" — could be `beverly-hills/plumbers` OR `california/beverly-hills/plumbers`), ask the user which URL variant they want UNLESS they've explicitly requested bulk/pattern-based updates.\n 3. Check for an existing `list_seo` record at that slug: `listWebPages` with `property=filename&property_value=<slug>&property_operator==`. If found → `updateWebPage`. If not → `createWebPage` with `seo_type=profile_search_results`, `filename=<slug>`, `content=<SEO HTML>`. **Always run the check-first step — BD does NOT reject duplicate `filename` values. If you skip the check and the page already exists, BD silently creates a second row with its own `seo_id`; both records will exist, and which one wins at render time is undefined. Duplicates orphan silently, no warning.**\n 4. On create, **required defaults** for `profile_search_results` pages (unless user explicitly overrides):\n - `seo_type=profile_search_results`\n - `content_active=1`\n - `custom_html_placement=4` (Below Body Content — safest for boilerplate SEO intro without disrupting the live member UI)\n - `form_name=\"Member Profile Page\"` (sidebar — one of the 5 Master Default Sidebars; always available on every site)\n - `menu_layout=3` (Left Slim — sidebar position)\n - `date_updated=<current YYYYMMDDHHmmss>` — set on EVERY create and update (BD does not auto-populate; blank leaves admin UI showing no update date)\n - `updated_by` — optional but recommended, e.g. `\"AI Agent\"` or `\"API\"` for audit trail\n - **If user requests a different sidebar and it is NOT in the 5 master defaults OR `listSidebars` customs → ask:** \"That sidebar isn't available on this site. OK to use `Member Profile Page` (default) instead, or would you like to pick from [list of available]?\"\n 5. **MUST auto-generate SEO-optimized meta for the specific location+category combo** — don't leave these blank on a search-results SEO page, that defeats the whole purpose. Agent populates the following from the human names (not slugs), using natural \"in [city]\" / \"[city] [category] near me\" / \"best [category] in [location]\" phrasing, respecting each field's char budget, and VARYING Title vs Social Title so social platforms show different copy than the Google snippet:\n - `title` — Page Meta Title. 50–60 chars ideal, ≤70 hard max. Format: `\"[Top Sub-category or Top category] in [City], [State] | [Site Name]\"` or similar. BD stores the value verbatim — Google/Bing truncate at ~55–60 chars in the SERP snippet, so keep the important words in the first 55. Pre-truncate client-side if you want precise control.\n - `meta_desc` — Meta Description. 150–160 chars ideal, ≤170 max. 1–2 sentence pitch naming the location and category, with a CTA.\n - `meta_keywords` — comma-separated, ~200 chars. Low SEO weight today but fill anyway: `\"[category] [city], [sub-cat] [city], [category] near me, [city] [state] [category]\"`.\n - `facebook_title` — Open Graph title. 55–60 chars ideal. Should differ from `title` — more conversational for social shares.\n - `facebook_desc` — Open Graph description. 110–125 chars ideal. Shorter than `meta_desc`, punchier for social feeds.\n - **DO NOT auto-set `facebook_image`** — requires an uploaded asset from the customer.\n 6. **h1/h2 double-render trap:** if the hero section is enabled (`enable_hero_section=1` or `2`), the page's `h1` and `h2` text fields render inside the hero banner. If your `content` HTML ALSO contains an `<h1>` or `<h2>`, the page renders BOTH — creating duplicate headings (bad for SEO). Safe rule: if you put `<h1>`/`<h2>` inside `content`, leave the page's `h1`/`h2` fields empty; if you want the hero to show the heading, set `h1`/`h2` on the record and don't repeat it in `content`.\n 7. `custom_html_placement` is only meaningful on `profile_search_results` (and later `data_category`) page types — ignored on regular `content` pages.\n 8. **Country-only slug caveat (live-verified):** `filename=<country_slug>` (e.g. `united-states` by itself) stores as a `list_seo` record but **does NOT render a public URL** — BD has no standalone country-level dynamic search route, so the slug 404s. The country slug is only useful as a LEFT-PARENT PREFIX to a longer slug (e.g. `united-states/california/los-angeles/plumbers`). Country-alone works fine for `content`-type pages via `filename`; the 404 is specific to `profile_search_results`.\n\nBD handles the dynamic-to-static takeover automatically: once a `list_seo` record exists with a matching slug and `content_active=1`, it overrides the dynamic page for that URL. Millions of dynamic search URLs can exist on a site without any `list_seo` rows — they only enter `list_seo` when an admin/API explicitly converts them to static pages.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
9266
|
+
"description": "Update an existing web page by `seo_id`. Fields omitted are untouched. Writes live data.\n\nChanges go live immediately. No cache refresh needed for most edits. If changing `filename` (URL slug), consider creating a 301 via `createRedirect` so inbound links to the old slug keep working.\n\n**Use when:** editing copy, meta tags, social-share images, or toggling layout flags (hide header/footer, full-width, etc.). Changing `filename` breaks inbound links — create a `Redirect` via `createRedirect` to preserve SEO.\n\n**Required:** `seo_id`, `date_updated` (YYYYMMDDHHmmss — BD does not auto-populate; blank leaves admin UI \"Last Update\" stale).\n\n**Common edits:**\n- Copy/content: `content`, `h1`, `h2`, `seo_text`, `content_footer`\n- SEO: `title`, `meta_desc`, `meta_keywords`\n- Social: `facebook_title`, `facebook_desc`, `facebook_image`\n- Layout: `content_layout`, `hide_header`, `hide_footer`, etc. (see mapping below)\n- Visibility: `content_active` (1 = live, 0 = hidden)\n\n**See also:** `createWebPage` (add new), `deleteWebPage` (remove), `createRedirect` (after slug changes).\n\n**Writes live data:** immediately visible.\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n**BD Admin UI — field label mapping:**\n\nSome field names are opaque; this is what they're called in the BD admin page-settings screens.\n\n*Display/layout toggles (integer 0/1 unless noted):*\n| Field | Admin UI label |\n|---|---|\n| `content_layout` | Full Screen Page Width |\n| `section` | Hide Banner Ad Modules |\n| `hide_header` | Hide Header |\n| `hide_footer` | Hide Footer |\n| `hide_top_right` | Hide Top Header Menu |\n| `hide_header_links` | Hide Main Menu |\n| `content_images` | Click-Enlarge Images (value: `click_to_enlarge` to enable) |\n| `show_form` | **Apply NoIndex, NoFollow** (NOT a contact-form toggle — BD repurposed this column) |\n| `disable_css_stylesheets` | Disable Default CSS Stylesheets |\n| `disable_preview_screenshot` | Disable Screenshot Preview |\n| `seo_text` | Wildcard URL Rewrite (catch-all routing) |\n\n*SEO / meta:*\n| Field | Admin UI label |\n|---|---|\n| `title` | Page Meta Title |\n| `meta_desc` | Meta Description |\n| `meta_keywords` | Meta Keywords |\n| `h1` | H1 Heading |\n| `h2` | H2 Heading |\n\n*Social (Open Graph):*\n| Field | Admin UI label |\n|---|---|\n| `facebook_title` | Social Media Title |\n| `facebook_desc` | Social Media Description |\n| `facebook_image` | Social Media Shared Image (≥200×200px) |\n\nTemplate tokens: `title`, `meta_desc`, `meta_keywords`, `h1`, `h2` all support `%%%website_name%%%`, `%industry%`, `%profession%` (expanded at render time).\n\n**Hero section (optional banner rendered above page content):** toggled via `enable_hero_section` (`0`=off, `1`=all devices, `2`=hide on mobile). The full hero config spans ~23 fields: `hero_image` (external URLs supported natively — no `auto_image_import` needed), `hero_background_image_size`, `hero_content_overlay_color` (RGB format ONLY, e.g. `rgb(0,0,0)` — hex not accepted), `hero_content_overlay_opacity`, `hero_top_padding`/`hero_bottom_padding`, `hero_column_width`, `hero_alignment`, H1 styling (`h1_font_color`/`h1_font_size`/`h1_font_weight`), H2 styling (`h2_font_color`/`h2_font_size`/`h2_font_weight`), additional content styling (`hero_content_font_color`/`hero_content_font_size`/`hero_section_content`), CTA (`hero_link_url`/`hero_link_text`/`hero_link_target_blank`/`hero_link_size`/`hero_link_color`), and `hero_hide_banner_ad` to suppress the site-wide Below Header Banner Ad on this page. All color fields require RGB format. `enable_hero_section=0` is a master kill-switch — other hero_* values remain stored but are not rendered. The H1/H2 TEXT itself comes from the page's top-level `h1` and `h2` fields; the `h1_*`/`h2_*` here control ONLY hero styling. **Homepage:** the homepage record (`seo_type=home`, typically `seo_id=1`) cannot be CREATED via API — it's system-seeded. For homepage edits use `updateWebPage` with the existing `seo_id`. **Hero fields do NOT apply to the homepage.** The homepage template ignores `enable_hero_section` and all `hero_*`/`h1_*`/`h2_*` fields — BD accepts and stores them on the record, but they never render. Skip hero fields entirely when updating the homepage.\n\n**Hero safe-defaults — ALWAYS apply when `enable_hero_section=1` or `2` and the agent is the one enabling the hero** (unless the user explicitly overrides a value). These defaults ensure text is readable over any background image:\n- `h1_font_color=\"rgb(255,255,255)\"` — white H1 readable over most hero images\n- `h2_font_color=\"rgb(255,255,255)\"` — matching white H2\n- `hero_content_overlay_color=\"rgb(0,0,0)\"` — black overlay layer\n- `hero_content_overlay_opacity=\"0.5\"` — at 0.5 (admin-UI level 5 of 10), dims the background enough for white text to pop without obscuring the image. **EAV-STORED — `createWebPage` writes this correctly, but `updateWebPage` silently drops it. On updates, write it via `updateUserMeta`/`createUserMeta` with `database=list_seo`. See the EAV workaround section below.**\n- `hero_top_padding=\"100\"` — 100px breathing room above hero content\n- `hero_bottom_padding=\"100\"` — 100px below\n\nApplies to BOTH `seo_type=content` and `seo_type=profile_search_results` pages. Universal readability rule.\n\n**Cache refresh REQUIRED after any hero create/update:** Hero changes do NOT reflect on the public URL until the site cache is refreshed. After ANY `createWebPage` or `updateWebPage` that touches hero fields (`enable_hero_section`, any `hero_*`, `h1_font_*`, `h2_font_*`), call `refreshSiteCache` immediately. Without the refresh, the admin dashboard will show the changes but visitors will see stale hero markup until BD's next scheduled cache cycle.\n\n**users_meta update workaround — CRITICAL for updates.** BD's `list_seo` table mixes direct columns with EAV-stored values in `users_meta`. On CREATE, `createWebPage` writes all fields correctly. On UPDATE, `updateWebPage` ONLY writes the direct columns — these 18 fields get silently ignored by the update path and must be written via `updateUserMeta` / `createUserMeta` instead: `linked_post_category`, `linked_post_type`, `disable_preview_screenshot`, `disable_css_stylesheets`, `hero_content_overlay_opacity`, `hero_link_target_blank`, `hero_background_image_size`, `hero_link_size`, `hero_link_color`, `hero_content_font_size`, `hero_section_content`, `hero_column_width`, `h2_font_weight`, `h1_font_weight`, `h2_font_size`, `h1_font_size`, `hero_link_text`, `hero_link_url`. Workflow per field: (1) `listUserMeta` filter by `database=list_seo`, `database_id=<seo_id>`, `key=<field>` to find the existing `meta_id`; (2) exists → `updateUserMeta(meta_id, value=...)`; (3) missing → `createUserMeta(database=list_seo, database_id=<seo_id>, key=<field>, value=<new value>)`. Reads merge automatically via `getWebPage`/`listWebPages` — you only need the workaround for WRITES. On `deleteWebPage`, also delete the corresponding users_meta rows (filter by the deleted `seo_id`) to prevent orphans.\n\n**Hero image sourcing for agents:** never use random-image placeholders (picsum.photos, lorempixel, placekitten) — those change per page load and look broken to real visitors. Pick a content-relevant stock photo from Pexels (free license, no attribution required) via a search term derived from the page topic. Use the LARGE variant URL (Pexels provides `?auto=compress&cs=tinysrgb&w=1800` as a query string on the images hostname) — not `original`, which is often 5000+px and too heavy for a hero banner. If the user supplies their own image URL, use that.\n\n**Member Search Results SEO pages (`seo_type=profile_search_results`) — thin-content remedy workflow:** BD auto-generates dynamic search-result pages for every valid combination of location + category on the site (e.g. `california/beverly-hills/plumbers`). Google often penalizes these when they return only 1–2 members (thin content). The remedy is to create a STATIC `list_seo` record with `seo_type=profile_search_results`, `filename=<the exact URL slug>`, and `content=<unique SEO copy>` (intro paragraph, local context, FAQ, etc.) — that static record then overrides the dynamic rendering and the custom copy renders alongside the live results.\n\n**CRITICAL — `filename` MUST be a real location/category slug BD's dynamic router recognizes.** The `profile_search_results` static page works by OVERRIDING an existing dynamic search URL. If the `filename` does NOT correspond to a valid BD dynamic URL built from actual country/state/city/top_category/sub_category slugs on THIS site, **the public URL will return HTTP 404 even though the `list_seo` record exists with `content_active=1`**. BD has no dynamic page to override, so nothing renders. Arbitrary / made-up / pattern-generator / test slugs like `foo-bar-baz`, `my-cool-page`, or `hero-test-page` WILL NOT render as `profile_search_results` pages — live-verified on 2026-04-19. Every segment of the slug must come from a verified live lookup: \n - country segment (optional left-parent): `listCountries` → lowercase `country_name` with spaces → hyphens\n - state segment: `listStates` → `state_filename`\n - city segment: `listCities` → `city_filename`\n - top-category segment: `listTopCategories` → `filename`\n - sub-category segment: `listSubCategories` → `filename`\nDo NOT construct `profile_search_results` slugs from arbitrary strings. If the user wants a static page at an arbitrary URL, use `seo_type=content` instead (content pages create their own route and render at any `filename`).\n\n*URL slug construction (the `filename` field, NO leading slash):* segments use hierarchy order and any left-parent is droppable to broaden the match. Always concatenate with `/` separators:\n - Fullest: `country/state/city/top_cat/sub_cat`\n - Common: `state/city/top_cat/sub_cat` (when site is single-country)\n - `city/top_cat/sub_cat`, `top_cat/sub_cat`, `city`, `state`, `top_cat`, etc.\n\n*Where each segment comes from:*\n - `country` segment: NOT a stored slug — derive from `list_countries.country_name` (via `listCountries`) by lowercasing and replacing spaces with hyphens (e.g. `\"United States\"` → `united-states`)\n - `state` segment: `location_states.state_filename` (via `listStates`)\n - `city` segment: `location_cities.city_filename` (via `listCities`)\n - `top_cat` segment: top category's `filename` (via `listTopCategories`)\n - `sub_cat` segment: sub-category's `filename` (via `listSubCategories`)\n\n*Agent workflow for \"add SEO to [category] in [location] page\":*\n 1. Resolve each named input to its slug via the relevant list endpoint (`listCities`, `listStates`, `listTopCategories`, `listSubCategories`) filtering by the full/human name field — exact-match `=` is reliable for these.\n 2. For ambiguous requests (e.g. user says \"Beverly Hills plumbers\" — could be `beverly-hills/plumbers` OR `california/beverly-hills/plumbers`), ask the user which URL variant they want UNLESS they've explicitly requested bulk/pattern-based updates.\n 3. Check for an existing `list_seo` record at that slug: `listWebPages` with `property=filename&property_value=<slug>&property_operator==`. If found → `updateWebPage`. If not → `createWebPage` with `seo_type=profile_search_results`, `filename=<slug>`, `content=<SEO HTML>`. **Always run the check-first step — BD does NOT reject duplicate `filename` values. If you skip the check and the page already exists, BD silently creates a second row with its own `seo_id`; both records will exist, and which one wins at render time is undefined. Duplicates orphan silently, no warning.**\n 4. On create, **required defaults** for `profile_search_results` pages (unless user explicitly overrides):\n - `seo_type=profile_search_results`\n - `content_active=1`\n - `custom_html_placement=4` (Below Body Content — safest for boilerplate SEO intro without disrupting the live member UI)\n - `form_name=\"Member Profile Page\"` (sidebar — one of the 5 Master Default Sidebars; always available on every site)\n - `menu_layout=3` (Left Slim — sidebar position)\n - `date_updated=<current YYYYMMDDHHmmss>` — set on EVERY create and update (BD does not auto-populate; blank leaves admin UI showing no update date)\n - `updated_by` — optional but recommended, e.g. `\"AI Agent\"` or `\"API\"` for audit trail\n - **If user requests a different sidebar and it is NOT in the 5 master defaults OR `listSidebars` customs → ask:** \"That sidebar isn't available on this site. OK to use `Member Profile Page` (default) instead, or would you like to pick from [list of available]?\"\n 5. **MUST auto-generate SEO-optimized meta for the specific location+category combo** — don't leave these blank on a search-results SEO page, that defeats the whole purpose. Agent populates the following from the human names (not slugs), using natural \"in [city]\" / \"[city] [category] near me\" / \"best [category] in [location]\" phrasing, respecting each field's char budget, and VARYING Title vs Social Title so social platforms show different copy than the Google snippet:\n - `title` — Page Meta Title. 50–60 chars ideal, ≤70 hard max. Format: `\"[Top Sub-category or Top category] in [City], [State] | [Site Name]\"` or similar. BD stores the value verbatim — Google/Bing truncate at ~55–60 chars in the SERP snippet, so keep the important words in the first 55. Pre-truncate client-side if you want precise control.\n - `meta_desc` — Meta Description. 150–160 chars ideal, ≤170 max. 1–2 sentence pitch naming the location and category, with a CTA.\n - `meta_keywords` — comma-separated, ~200 chars. Low SEO weight today but fill anyway: `\"[category] [city], [sub-cat] [city], [category] near me, [city] [state] [category]\"`.\n - `facebook_title` — Open Graph title. 55–60 chars ideal. Should differ from `title` — more conversational for social shares.\n - `facebook_desc` — Open Graph description. 110–125 chars ideal. Shorter than `meta_desc`, punchier for social feeds.\n - **DO NOT auto-set `facebook_image`** — requires an uploaded asset from the customer.\n 6. **h1/h2 double-render trap:** if the hero section is enabled (`enable_hero_section=1` or `2`), the page's `h1` and `h2` text fields render inside the hero banner. If your `content` HTML ALSO contains an `<h1>` or `<h2>`, the page renders BOTH — creating duplicate headings (bad for SEO). Safe rule: if you put `<h1>`/`<h2>` inside `content`, leave the page's `h1`/`h2` fields empty; if you want the hero to show the heading, set `h1`/`h2` on the record and don't repeat it in `content`.\n 7. `custom_html_placement` is only meaningful on `profile_search_results` (and later `data_category`) page types — ignored on regular `content` pages.\n 8. **Country-only slug caveat (live-verified):** `filename=<country_slug>` (e.g. `united-states` by itself) stores as a `list_seo` record but **does NOT render a public URL** — BD has no standalone country-level dynamic search route, so the slug 404s. The country slug is only useful as a LEFT-PARENT PREFIX to a longer slug (e.g. `united-states/california/los-angeles/plumbers`). Country-alone works fine for `content`-type pages via `filename`; the 404 is specific to `profile_search_results`.\n\nBD handles the dynamic-to-static takeover automatically: once a `list_seo` record exists with a matching slug and `content_active=1`, it overrides the dynamic page for that URL. Millions of dynamic search URLs can exist on a site without any `list_seo` rows — they only enter `list_seo` when an admin/API explicitly converts them to static pages.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
9245
9267
|
}
|
|
9246
9268
|
},
|
|
9247
9269
|
"/api/v2/list_seo/delete": {
|
|
@@ -9282,7 +9304,7 @@
|
|
|
9282
9304
|
}
|
|
9283
9305
|
}
|
|
9284
9306
|
},
|
|
9285
|
-
"description": "Permanently delete a web page by `seo_id`. Destructive — cannot be undone via API.\n\n**Use when:** permanently removing a page. For \"hide without deleting\" use `updateWebPage` with `content_active=0` — preserves the record and its SEO history, easily re-publishable.\n\n**Required:** `seo_id`.\n\n**Destructive:** confirm with the user. If inbound links or menus reference the deleted page's URL, consider creating a `createRedirect` BEFORE deleting so those links don't 404. Menus with items pointing at this page also need cleanup.\n\n**See also:** `updateWebPage` with `content_active=0` (hide without deleting — safer for reversible actions).\n\n**Returns:** `{ status: \"success\", message: \"list_seo record was deleted\" }`.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
9307
|
+
"description": "Permanently delete a web page by `seo_id`. Destructive — cannot be undone via API.\n\n**Use when:** permanently removing a page. For \"hide without deleting\" use `updateWebPage` with `content_active=0` — preserves the record and its SEO history, easily re-publishable.\n\n**Required:** `seo_id`.\n\n**Destructive:** confirm with the user. If inbound links or menus reference the deleted page's URL, consider creating a `createRedirect` BEFORE deleting so those links don't 404. Menus with items pointing at this page also need cleanup.\n\n**⚠️ ORPHAN CLEANUP REQUIRED — BD does NOT cascade-delete users_meta rows.** Each WebPage with a hero or custom layout has up to 18 EAV rows in `users_meta` (`database=list_seo`, `database_id=<seo_id>`). These persist after `deleteWebPage` unless you clean them up. Safe post-delete workflow:\n 1. Call `listUserMeta` filtered on `database=list_seo` AND `database_id=<deleted seo_id>`.\n 2. **Client-side filter the response** — keep only rows whose `database` field equals `list_seo`. The same `database_id` value may exist in `users_meta` pointing at unrelated parent tables (e.g. a member with `user_id=<seo_id>` in `users_data`), and those rows must NOT be deleted.\n 3. For each remaining row, call `deleteUserMeta` with `meta_id=<row.meta_id>`, `database=list_seo`, `database_id=<seo_id>` (all three required as of v6.7.1).\n\nNever loop-delete by `database_id` alone — you will silently destroy unrelated records on other tables.\n\n**See also:** `updateWebPage` with `content_active=0` (hide without deleting — safer for reversible actions).\n\n**Returns:** `{ status: \"success\", message: \"list_seo record was deleted\" }`.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
9286
9308
|
}
|
|
9287
9309
|
},
|
|
9288
9310
|
"/api/v2/redirect_301/get": {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "brilliant-directories-mcp",
|
|
3
3
|
"mcpName": "io.github.brilliantdirectories/brilliant-directories-mcp",
|
|
4
|
-
"version": "6.7.
|
|
4
|
+
"version": "6.7.2",
|
|
5
5
|
"description": "Official MCP server for Brilliant Directories — manage members, posts, leads, reviews, and more.",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"bin": {
|