brilliant-directories-mcp 5.2.1 → 5.3.0
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/openapi/bd-api.json +167 -167
- package/package.json +1 -1
package/openapi/bd-api.json
CHANGED
|
@@ -1155,7 +1155,7 @@
|
|
|
1155
1155
|
"get": {
|
|
1156
1156
|
"operationId": "verifyToken",
|
|
1157
1157
|
"summary": "Verify API key",
|
|
1158
|
-
"description": "Verify that your API key is valid and check rate limit status.\n\n**Parameter interactions:**\n- Call at the start of a session to confirm the API key is valid BEFORE issuing real calls — saves rate-limit budget on key-config errors\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
1158
|
+
"description": "Verify that your API key is valid and check rate limit status.\n\n**Use when:** at the start of any session or batch job, to confirm the API key is valid and the site is reachable BEFORE burning rate limit on real calls. Also useful for surfacing a clear \"bad credentials\" error to the user early.\n\n**Parameter interactions:**\n- Call at the start of a session to confirm the API key is valid BEFORE issuing real calls — saves rate-limit budget on key-config errors\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
1159
1159
|
"tags": [
|
|
1160
1160
|
"Authentication"
|
|
1161
1161
|
],
|
|
@@ -1177,7 +1177,7 @@
|
|
|
1177
1177
|
"get": {
|
|
1178
1178
|
"operationId": "getUserFields",
|
|
1179
1179
|
"summary": "Get user field definitions",
|
|
1180
|
-
"description": "Returns available fields for user records with labels and required flags. Use this to discover custom fields.\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._",
|
|
1180
|
+
"description": "Returns available fields for user records with labels and required flags. Use this to discover custom fields.\n\n**Use when:** building dynamic forms or importers — you need to discover which fields exist on the User record on THIS specific site (custom fields vary per BD site config). Also useful for validating import-CSV headers before running a batch.\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._",
|
|
1181
1181
|
"tags": [
|
|
1182
1182
|
"Users"
|
|
1183
1183
|
],
|
|
@@ -1199,7 +1199,7 @@
|
|
|
1199
1199
|
"get": {
|
|
1200
1200
|
"operationId": "listUsers",
|
|
1201
1201
|
"summary": "List members/users",
|
|
1202
|
-
"description": "Get a paginated list of all members. Supports filtering by any user field and sorting.\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.\n\n**Enums:** `property_operator`: `=`, `LIKE`, `>`, `<`, `>=`, `<=`; `order_type`: `ASC`, `DESC`.\n\n**See also:** `getUser` (single record by ID), `searchUsers` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\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._",
|
|
1202
|
+
"description": "Get a paginated list of all members. Supports filtering by any user field and sorting.\n\n**Use when:** enumerating members for reports, CSV exports, bulk status updates, analytics, or pagination through the full member base. Also used for lookups by field — pass `property=email` + `property_value=<email>` to find a single user by email. For keyword/text search use `searchUsers`; for a single user by known `user_id` use `getUser`.\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.\n\n**Enums:** `property_operator`: `=`, `LIKE`, `>`, `<`, `>=`, `<=`; `order_type`: `ASC`, `DESC`.\n\n**See also:** `getUser` (single record by ID), `searchUsers` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\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._",
|
|
1203
1203
|
"tags": [
|
|
1204
1204
|
"Users"
|
|
1205
1205
|
],
|
|
@@ -1269,7 +1269,7 @@
|
|
|
1269
1269
|
}
|
|
1270
1270
|
}
|
|
1271
1271
|
},
|
|
1272
|
-
"description": "Fetch a single user record. Read-only.\n\n**Required:** `user_id`.\n\n**See also:** `listUsers` (enumerate many), `searchUsers` (keyword search).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }` — the `message` array contains 1 record when found. Empty or HTTP 404 when not found.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\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._"
|
|
1272
|
+
"description": "Fetch a single user record. Read-only.\n\n**Use when:** you already have the `user_id` (from `listUsers`, `searchUsers`, a prior create, or a webhook payload) and need the full member record. Cheaper than `listUsers` + filter. For lookups by email or other field, use `listUsers` with `property`/`property_value`.\n\n**Required:** `user_id`.\n\n**See also:** `listUsers` (enumerate many), `searchUsers` (keyword search).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }` — the `message` array contains 1 record when found. Empty or HTTP 404 when not found.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\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._"
|
|
1273
1273
|
}
|
|
1274
1274
|
},
|
|
1275
1275
|
"/api/v2/user/create": {
|
|
@@ -1539,14 +1539,14 @@
|
|
|
1539
1539
|
}
|
|
1540
1540
|
}
|
|
1541
1541
|
},
|
|
1542
|
-
"description": "Create a new user record. Writes live data.\n\n**Required:** `email`, `password`, `subscription_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `email`, `password`, `subscription_id` are all required together — `subscription_id` must be an existing membership plan (discover via `listMembershipPlans`)\n- `profession_id` + `services` — top-level category and comma-separated sub-category IDs\n- `auto_geocode=1` requires the \"Pretty URLs with Google Maps\" site feature enabled\n- `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\n\n**See also:** `updateUser` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan (from `listMembershipPlans` / `createMembershipPlan`). Categories (`profession_id` / `profession_name` / `services`) are AUTO-CREATED on `createUser` if the names don't exist (see Category handling below) — they do NOT need to exist beforehand.\n\n\n\n**Category handling — IDs OR names, with sub-sub support (source: user.php:1840-1940, verified live 2026-04-18):**\n\n*Top-level category (profession) — pick ONE:*\n- `profession_id` (numeric) — must reference an existing row in `list_professions`\n- `profession_name` (string) — alternative by name\n\n*`services` parameter (sub-categories) supports 4 formats:*\n| Format | Example | Effect |\n|---|---|---|\n| Single by ID or name | `services=\"1823\"` or `services=\"PVC repair\"` | One sub-category |\n| Multiple | `services=\"PVC repair,Water heater\"` or `services=\"1823,1824\"` | Multiple subs |\n| Sub + sub-sub via `=>` | `services=\"Honda=>2022\"` | Creates sub \"Honda\" and sub-sub \"2022\" under Honda |\n| Mixed subs + sub-subs | `services=\"Honda=>2022,Honda=>2023,Toyota\"` | Combine in one call |\n\n*Critical rules:*\n- **`profession_id` (or `profession_name`) is REQUIRED when passing `services`** — without it, service relationships fail silently (`user.php:1876`)\n- **Do NOT mix IDs and names** within a single `services` call — pick one format\n- **Right side of `=>` is NAME-ONLY** — no ID lookup; sub-sub must be passed by name\n- **Whitespace around commas is trimmed** — `\"a, b, c\"` works the same as `\"a,b,c\"`\n\n*Auto-create on create: ALWAYS ON.* `createUser` has `create_new_categories=true` hardcoded in `createActions()`. Unknown category/service/sub-sub names are auto-created automatically — no flag needed.\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._"
|
|
1542
|
+
"description": "Create a new user record. Writes live data.\n\n**Use when:** adding a member from outside the BD signup form — CSV imports, web-scraped business listings, Zapier/automation integrations, admin-created test accounts. By default no welcome email fires (set `send_email_notifications=1` to trigger one). Categories and sub-categories are auto-created by name — no need to `createTopCategory` first.\n\n**Required:** `email`, `password`, `subscription_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `email`, `password`, `subscription_id` are all required together — `subscription_id` must be an existing membership plan (discover via `listMembershipPlans`)\n- `profession_id` + `services` — top-level category and comma-separated sub-category IDs\n- `auto_geocode=1` requires the \"Pretty URLs with Google Maps\" site feature enabled\n- `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\n\n**See also:** `updateUser` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan (from `listMembershipPlans` / `createMembershipPlan`). Categories (`profession_id` / `profession_name` / `services`) are AUTO-CREATED on `createUser` if the names don't exist (see Category handling below) — they do NOT need to exist beforehand.\n\n\n\n**Category handling — IDs OR names, with sub-sub support (source: user.php:1840-1940, verified live 2026-04-18):**\n\n*Top-level category (profession) — pick ONE:*\n- `profession_id` (numeric) — must reference an existing row in `list_professions`\n- `profession_name` (string) — alternative by name\n\n*`services` parameter (sub-categories) supports 4 formats:*\n| Format | Example | Effect |\n|---|---|---|\n| Single by ID or name | `services=\"1823\"` or `services=\"PVC repair\"` | One sub-category |\n| Multiple | `services=\"PVC repair,Water heater\"` or `services=\"1823,1824\"` | Multiple subs |\n| Sub + sub-sub via `=>` | `services=\"Honda=>2022\"` | Creates sub \"Honda\" and sub-sub \"2022\" under Honda |\n| Mixed subs + sub-subs | `services=\"Honda=>2022,Honda=>2023,Toyota\"` | Combine in one call |\n\n*Critical rules:*\n- **`profession_id` (or `profession_name`) is REQUIRED when passing `services`** — without it, service relationships fail silently (`user.php:1876`)\n- **Do NOT mix IDs and names** within a single `services` call — pick one format\n- **Right side of `=>` is NAME-ONLY** — no ID lookup; sub-sub must be passed by name\n- **Whitespace around commas is trimmed** — `\"a, b, c\"` works the same as `\"a,b,c\"`\n\n*Auto-create on create: ALWAYS ON.* `createUser` has `create_new_categories=true` hardcoded in `createActions()`. Unknown category/service/sub-sub names are auto-created automatically — no flag needed.\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._"
|
|
1543
1543
|
}
|
|
1544
1544
|
},
|
|
1545
1545
|
"/api/v2/user/update": {
|
|
1546
1546
|
"put": {
|
|
1547
1547
|
"operationId": "updateUser",
|
|
1548
1548
|
"summary": "Update an existing member/user",
|
|
1549
|
-
"description": "Update any user field. Supports special actions: member_tag_action + member_tags, credit_action + credit_amount, images_action, services, auto_geocode.\n\n**Required:** `user_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `member_tag_action=1` + `member_tags` — apply tag changes (comma-separated tag IDs from `listTags`)\n- `credit_action` (`add`/`deduct`/`override`) + `credit_amount` — adjust member credit balance\n- `images_action` — remove stored images: `remove_all`, `remove_cover_image`, `remove_logo_image`, `remove_profile_image`\n- `services` format: `category=>service1,service2` (category ID, then comma-separated service IDs)\n- `auto_geocode=1` requires the \"Pretty URLs with Google - `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\nMaps\" site feature enabled\n\n**See also:** `createUser` (add new), `deleteUser` (remove permanently).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }` — the full updated record after changes applied.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan. For categories, existing IDs/names work by default; to auto-create unknown names during update, pass `create_new_categories=1` (see Category handling below).\n\n\n\n**Category handling — IDs OR names, with sub-sub support (source: user.php:1840-1940, verified live 2026-04-18):**\n\n*Top-level category (profession) — pick ONE:*\n- `profession_id` (numeric) — must reference an existing row in `list_professions`\n- `profession_name` (string) — alternative by name\n\n*`services` parameter (sub-categories) supports 4 formats:*\n| Format | Example | Effect |\n|---|---|---|\n| Single by ID or name | `services=\"1823\"` or `services=\"PVC repair\"` | One sub-category |\n| Multiple | `services=\"PVC repair,Water heater\"` or `services=\"1823,1824\"` | Multiple subs |\n| Sub + sub-sub via `=>` | `services=\"Honda=>2022\"` | Creates sub \"Honda\" and sub-sub \"2022\" under Honda |\n| Mixed subs + sub-subs | `services=\"Honda=>2022,Honda=>2023,Toyota\"` | Combine in one call |\n\n*Critical rules:*\n- **`profession_id` (or `profession_name`) is REQUIRED when passing `services`** — without it, service relationships fail silently (`user.php:1876`)\n- **Do NOT mix IDs and names** within a single `services` call — pick one format\n- **Right side of `=>` is NAME-ONLY** — no ID lookup; sub-sub must be passed by name\n- **Whitespace around commas is trimmed** — `\"a, b, c\"` works the same as `\"a,b,c\"`\n\n*Auto-create on update: OFF by default.* Unknown category/service names are silently skipped unless you explicitly pass `create_new_categories=1`.\n\n*Destructive side effect — `user.php:1832`:* **Changing `profession_id` on `updateUser` wipes all existing service (sub-category) relations for that member.** To move a member to a new top-level category without losing their sub-categories, re-send the complete `services` list in the same `updateUser` call.\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._",
|
|
1549
|
+
"description": "Update any user field. Supports special actions: member_tag_action + member_tags, credit_action + credit_amount, images_action, services, auto_geocode.\n\n**Use when:** changing any field on an existing member — status changes (e.g., `active=3` to cancel instead of delete), tag edits, credit adjustments, category reassignment, profile image swaps. Prefer this over `deleteUser` for \"remove from public view\" since it's reversible. Note: changing `profession_id` wipes existing sub-category relations — re-send `services` in the same call to preserve them.\n\n**Required:** `user_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `member_tag_action=1` + `member_tags` — apply tag changes (comma-separated tag IDs from `listTags`)\n- `credit_action` (`add`/`deduct`/`override`) + `credit_amount` — adjust member credit balance\n- `images_action` — remove stored images: `remove_all`, `remove_cover_image`, `remove_logo_image`, `remove_profile_image`\n- `services` format: `category=>service1,service2` (category ID, then comma-separated service IDs)\n- `auto_geocode=1` requires the \"Pretty URLs with Google - `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\nMaps\" site feature enabled\n\n**See also:** `createUser` (add new), `deleteUser` (remove permanently).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }` — the full updated record after changes applied.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan. For categories, existing IDs/names work by default; to auto-create unknown names during update, pass `create_new_categories=1` (see Category handling below).\n\n\n\n**Category handling — IDs OR names, with sub-sub support (source: user.php:1840-1940, verified live 2026-04-18):**\n\n*Top-level category (profession) — pick ONE:*\n- `profession_id` (numeric) — must reference an existing row in `list_professions`\n- `profession_name` (string) — alternative by name\n\n*`services` parameter (sub-categories) supports 4 formats:*\n| Format | Example | Effect |\n|---|---|---|\n| Single by ID or name | `services=\"1823\"` or `services=\"PVC repair\"` | One sub-category |\n| Multiple | `services=\"PVC repair,Water heater\"` or `services=\"1823,1824\"` | Multiple subs |\n| Sub + sub-sub via `=>` | `services=\"Honda=>2022\"` | Creates sub \"Honda\" and sub-sub \"2022\" under Honda |\n| Mixed subs + sub-subs | `services=\"Honda=>2022,Honda=>2023,Toyota\"` | Combine in one call |\n\n*Critical rules:*\n- **`profession_id` (or `profession_name`) is REQUIRED when passing `services`** — without it, service relationships fail silently (`user.php:1876`)\n- **Do NOT mix IDs and names** within a single `services` call — pick one format\n- **Right side of `=>` is NAME-ONLY** — no ID lookup; sub-sub must be passed by name\n- **Whitespace around commas is trimmed** — `\"a, b, c\"` works the same as `\"a,b,c\"`\n\n*Auto-create on update: OFF by default.* Unknown category/service names are silently skipped unless you explicitly pass `create_new_categories=1`.\n\n*Destructive side effect — `user.php:1832`:* **Changing `profession_id` on `updateUser` wipes all existing service (sub-category) relations for that member.** To move a member to a new top-level category without losing their sub-categories, re-send the complete `services` list in the same `updateUser` call.\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._",
|
|
1550
1550
|
"tags": [
|
|
1551
1551
|
"Users"
|
|
1552
1552
|
],
|
|
@@ -1879,14 +1879,14 @@
|
|
|
1879
1879
|
}
|
|
1880
1880
|
}
|
|
1881
1881
|
},
|
|
1882
|
-
"description": "Permanently delete a user record by ID. Destructive — cannot be undone via API.\n\n**Required:** `user_id`.\n\n**Parameter interactions:**\n- `delete_images=1` (optional) — also deletes the member's stored profile/cover/logo images from site storage\n\n**See also:** `updateUser` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
1882
|
+
"description": "Permanently delete a user record by ID. Destructive — cannot be undone via API.\n\n**Use when:** the member record truly must be purged (GDPR request, test cleanup, confirmed duplicate). For reversible removal prefer `updateUser` with `active=3` (Canceled) — the record stays queryable and can be reactivated. Use `delete_images=1` to also purge stored profile/cover/logo images.\n\n**Required:** `user_id`.\n\n**Parameter interactions:**\n- `delete_images=1` (optional) — also deletes the member's stored profile/cover/logo images from site storage\n\n**See also:** `updateUser` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
1883
1883
|
}
|
|
1884
1884
|
},
|
|
1885
1885
|
"/api/v2/user/search": {
|
|
1886
1886
|
"post": {
|
|
1887
1887
|
"operationId": "searchUsers",
|
|
1888
1888
|
"summary": "Search members/users",
|
|
1889
|
-
"description": "Full-text search across members with category, location, and sorting options.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**Enums:** `sort`: `reviews`, `name ASC`, `name DESC`, `last_name_asc`, `last_name_desc`.\n\n**Parameter interactions:**\n- `q` — keyword (matches first name, last name, company, about, search_description)\n- `pid` (category ID), `tid` (sub-category/service ID), `ttid` (sub-sub-category) — taxonomy filters, use IDs from `listTopCategories` / `listSubCategories`\n- `address` + `dynamic=1` — proximity/geographic filtering\n- `output_type=html` returns server-rendered HTML; `array` (default) returns structured JSON\n\n**See also:** `getUser` (single record by ID), `listUsers` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\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._",
|
|
1889
|
+
"description": "Full-text search across members with category, location, and sorting options.\n\n**Use when:** the user has a keyword / partial name / location / category and wants matching members. This is the full-text search backend that powers the public site's member-search page. For an exact-field lookup (by email, by user_id, by phone) use `listUsers` + `property`/`property_value` instead — it's faster and more precise.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**Enums:** `sort`: `reviews`, `name ASC`, `name DESC`, `last_name_asc`, `last_name_desc`.\n\n**Parameter interactions:**\n- `q` — keyword (matches first name, last name, company, about, search_description)\n- `pid` (category ID), `tid` (sub-category/service ID), `ttid` (sub-sub-category) — taxonomy filters, use IDs from `listTopCategories` / `listSubCategories`\n- `address` + `dynamic=1` — proximity/geographic filtering\n- `output_type=html` returns server-rendered HTML; `array` (default) returns structured JSON\n\n**See also:** `getUser` (single record by ID), `listUsers` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\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._",
|
|
1890
1890
|
"tags": [
|
|
1891
1891
|
"Users"
|
|
1892
1892
|
],
|
|
@@ -1967,7 +1967,7 @@
|
|
|
1967
1967
|
"post": {
|
|
1968
1968
|
"operationId": "loginUser",
|
|
1969
1969
|
"summary": "Validate user credentials",
|
|
1970
|
-
"description": "Checks if email/password are valid. Does NOT return profile data — use getUser after.\n\n**Required:** `email`, `password`.\n\n**Parameter interactions:**\n- Does NOT return profile data on success — follow with `getUser` using the verified email to retrieve the member record\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
1970
|
+
"description": "Checks if email/password are valid. Does NOT return profile data — use getUser after.\n\n**Use when:** implementing SSO or a custom login flow against BD — you need to verify a member's email+password is valid WITHOUT starting a web session. Does NOT return profile data; follow with `getUser` or `listUsers` to fetch the authenticated member's record.\n\n**Required:** `email`, `password`.\n\n**Parameter interactions:**\n- Does NOT return profile data on success — follow with `getUser` using the verified email to retrieve the member record\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
1971
1971
|
"tags": [
|
|
1972
1972
|
"Users"
|
|
1973
1973
|
],
|
|
@@ -2011,7 +2011,7 @@
|
|
|
2011
2011
|
"/api/v2/user/transactions": {
|
|
2012
2012
|
"post": {
|
|
2013
2013
|
"operationId": "getUserTransactions",
|
|
2014
|
-
"summary": "Get
|
|
2014
|
+
"summary": "Get member billing transactions (invoices)",
|
|
2015
2015
|
"tags": [
|
|
2016
2016
|
"Users"
|
|
2017
2017
|
],
|
|
@@ -2045,13 +2045,13 @@
|
|
|
2045
2045
|
}
|
|
2046
2046
|
}
|
|
2047
2047
|
},
|
|
2048
|
-
"description": "Fetch a
|
|
2048
|
+
"description": "Fetch the billing transaction history (invoices) for a specific member. Read-only. Backed by the WHMCS billing integration.\n\n**Required:** `user_id` (POST body).\n\n**Use when:** you need to see a member's paid/unpaid invoices, payment methods, billing history, or reconcile billing status. Common reasons: answering a member's \"what did I pay for?\" question, exporting billing history, auditing revenue per member.\n\n**See also:** `getUserSubscriptions` (active/past membership plan signups — different resource from invoices), `getUser` (member profile).\n\n**Returns:** `{ status: \"success\", message: { total: <count>, invoices: [{...invoice records}] } }`. Each invoice includes `id`, `invoicenum`, `date`, `duedate`, `datepaid`, `subtotal`, `credit`, `tax`, `total`, `status` (`Paid`, `Unpaid`, etc.), `paymentmethod`, and an `items` array with per-line `description`, `amount`, `type`, etc. NOT a simple list of rows — the `message` is an object containing `invoices` as the array.\n\n**Reference support articles:**\n- https://support.brilliantdirectories.com/support/solutions/articles/12000108047 (API Reference — Users)\n- https://support.brilliantdirectories.com/support/solutions/articles/12000103947 (Users API — How to Manage Users with API Calls)\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._"
|
|
2049
2049
|
}
|
|
2050
2050
|
},
|
|
2051
2051
|
"/api/v2/user/subscriptions": {
|
|
2052
2052
|
"post": {
|
|
2053
2053
|
"operationId": "getUserSubscriptions",
|
|
2054
|
-
"summary": "Get
|
|
2054
|
+
"summary": "Get member subscriptions (membership plan history)",
|
|
2055
2055
|
"tags": [
|
|
2056
2056
|
"Users"
|
|
2057
2057
|
],
|
|
@@ -2085,7 +2085,7 @@
|
|
|
2085
2085
|
}
|
|
2086
2086
|
}
|
|
2087
2087
|
},
|
|
2088
|
-
"description": "Fetch a
|
|
2088
|
+
"description": "Fetch the subscription / membership-plan history for a specific member. Read-only. Backed by the WHMCS billing integration.\n\n**Required:** `user_id` (POST body).\n\n**Use when:** checking a member's current membership plan, their billing cycle (Monthly/Yearly), next due date, plan upgrade history, whether auto-renewal is on, or past canceled subscriptions.\n\n**See also:** `getUserTransactions` (invoice-level billing records — different resource), `getUser` (member profile — profile-level subscription references `subscription_id`), `listMembershipPlans` (all plan definitions on the site).\n\n**Returns:** `{ status: \"success\", message: { total: <count>, subscriptions: [{...subscription records}] } }`. Each subscription includes `id`, `userid`, `packageid` (membership plan ID), `regdate`, `nextduedate`, `billingcycle` (e.g. `Monthly`, `Yearly`), `paymentmethod`, `amount`, `domainstatus` (`Active`, `Cancelled`, etc.), and related fields. NOT a simple list of rows — the `message` is an object containing `subscriptions` as the array.\n\n**Reference support articles:**\n- https://support.brilliantdirectories.com/support/solutions/articles/12000108047 (API Reference — Users)\n- https://support.brilliantdirectories.com/support/solutions/articles/12000103947 (Users API — How to Manage Users with API Calls)\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._"
|
|
2089
2089
|
}
|
|
2090
2090
|
},
|
|
2091
2091
|
"/api/v2/users_reviews/get": {
|
|
@@ -2124,7 +2124,7 @@
|
|
|
2124
2124
|
}
|
|
2125
2125
|
}
|
|
2126
2126
|
},
|
|
2127
|
-
"description": "Paginated enumeration of review records. Read-only.\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.\n\n**Enums:** `property_operator`: `=`, `LIKE`, `>`, `<`, `>=`, `<=`.\n\n**See also:** `getReview` (single record by ID), `searchReviews` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2127
|
+
"description": "Paginated enumeration of review records. Read-only.\n\n**Use when:** building moderation queues (filter `review_status=0` for Pending), exporting all reviews, running review-velocity reports, or paginating through every review on the site. For searching by keyword in review text use `searchReviews`; for a single known review use `getReview`.\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.\n\n**Enums:** `property_operator`: `=`, `LIKE`, `>`, `<`, `>=`, `<=`.\n\n**See also:** `getReview` (single record by ID), `searchReviews` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2128
2128
|
}
|
|
2129
2129
|
},
|
|
2130
2130
|
"/api/v2/users_reviews/get/{review_id}": {
|
|
@@ -2156,7 +2156,7 @@
|
|
|
2156
2156
|
}
|
|
2157
2157
|
}
|
|
2158
2158
|
},
|
|
2159
|
-
"description": "Fetch a single review record. Read-only.\n\n**Required:** `review_id`.\n\n**See also:** `listReviews` (enumerate many), `searchReviews` (keyword search).\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._"
|
|
2159
|
+
"description": "Fetch a single review record. Read-only.\n\n**Use when:** investigating one specific review (usually from a moderation notification or support ticket that includes the `review_id`). For bulk moderation use `listReviews` with `review_status` filter.\n\n**Required:** `review_id`.\n\n**See also:** `listReviews` (enumerate many), `searchReviews` (keyword search).\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._"
|
|
2160
2160
|
}
|
|
2161
2161
|
},
|
|
2162
2162
|
"/api/v2/users_reviews/create": {
|
|
@@ -2228,7 +2228,7 @@
|
|
|
2228
2228
|
}
|
|
2229
2229
|
}
|
|
2230
2230
|
},
|
|
2231
|
-
"description": "Create a new review record. Writes live data.\n\n**Required:** `user_id`.\n\n**Parameter interactions:**\n- `user_id` — the member being reviewed\n- `rating_overall`: integer 1-5 (higher = better)\n- `recommend`: `0`=No, `1`=Yes (shown as a thumbs-up recommendation flag)\n- `review_status` controls initial visibility — default flow is `0` Pending → admin review\n\n**See also:** `updateReview` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
2231
|
+
"description": "Create a new review record. Writes live data.\n\n**Use when:** importing legacy reviews from another platform, adding placeholder reviews for test data, or scripting review submissions from an external integration. Real member-submitted reviews come through the BD review form — only use this API when bypassing that form.\n\n**Required:** `user_id`.\n\n**Parameter interactions:**\n- `user_id` — the member being reviewed\n- `rating_overall`: integer 1-5 (higher = better)\n- `recommend`: `0`=No, `1`=Yes (shown as a thumbs-up recommendation flag)\n- `review_status` controls initial visibility — default flow is `0` Pending → admin review\n\n**See also:** `updateReview` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
2232
2232
|
}
|
|
2233
2233
|
},
|
|
2234
2234
|
"/api/v2/users_reviews/update": {
|
|
@@ -2293,7 +2293,7 @@
|
|
|
2293
2293
|
}
|
|
2294
2294
|
}
|
|
2295
2295
|
},
|
|
2296
|
-
"description": "Update an existing review record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `review_id`.\n\n**Enums:** `review_status`: `0`=Pending, `2`=Accepted, `3`=Declined, `4`=Waiting for Admin.\n\n**See also:** `createReview` (add new), `deleteReview` (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._"
|
|
2296
|
+
"description": "Update an existing review record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** moderating — change `review_status` (`0`=Pending → `2`=Accepted to publish, `3`=Declined to reject, `4`=Waiting for Admin). Also used for admin corrections of typos in review text.\n\n**Required:** `review_id`.\n\n**Enums:** `review_status`: `0`=Pending, `2`=Accepted, `3`=Declined, `4`=Waiting for Admin.\n\n**See also:** `createReview` (add new), `deleteReview` (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._"
|
|
2297
2297
|
}
|
|
2298
2298
|
},
|
|
2299
2299
|
"/api/v2/users_reviews/delete": {
|
|
@@ -2333,7 +2333,7 @@
|
|
|
2333
2333
|
}
|
|
2334
2334
|
}
|
|
2335
2335
|
},
|
|
2336
|
-
"description": "Permanently delete a review record by ID. Destructive — cannot be undone via API.\n\n**Required:** `review_id`.\n\n**See also:** `updateReview` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
2336
|
+
"description": "Permanently delete a review record by ID. Destructive — cannot be undone via API.\n\n**Use when:** the review content violates policy and must be purged (spam, abuse, PII). For \"hide without removing\" use `updateReview` with `review_status=3` (Declined) — preserves the audit trail.\n\n**Required:** `review_id`.\n\n**See also:** `updateReview` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
2337
2337
|
}
|
|
2338
2338
|
},
|
|
2339
2339
|
"/api/v2/users_reviews/search": {
|
|
@@ -2379,7 +2379,7 @@
|
|
|
2379
2379
|
}
|
|
2380
2380
|
}
|
|
2381
2381
|
},
|
|
2382
|
-
"description": "Keyword search across review records. Read-only.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**Enums:** `review_status`: `0`=Pending, `2`=Accepted, `3`=Declined, `4`=Waiting for Admin.\n\n**See also:** `getReview` (single record by ID), `listReviews` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\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._"
|
|
2382
|
+
"description": "Keyword search across review records. Read-only.\n\n**Use when:** the admin wants to find reviews by keyword, filter by status, or look up all reviews for one member (pass `user_id`). For full enumeration use `listReviews`.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**Enums:** `review_status`: `0`=Pending, `2`=Accepted, `3`=Declined, `4`=Waiting for Admin.\n\n**See also:** `getReview` (single record by ID), `listReviews` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\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._"
|
|
2383
2383
|
}
|
|
2384
2384
|
},
|
|
2385
2385
|
"/api/v2/users_clicks/get": {
|
|
@@ -2415,7 +2415,7 @@
|
|
|
2415
2415
|
}
|
|
2416
2416
|
}
|
|
2417
2417
|
},
|
|
2418
|
-
"description": "Paginated enumeration of click records. Read-only.\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.\n\n**See also:** `getClick` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2418
|
+
"description": "Paginated enumeration of click records. Read-only.\n\n**Use when:** pulling click-tracking analytics for reports — profile views, phone reveals, website clicks, email clicks. Filter by `user_id` to see clicks for one member.\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.\n\n**See also:** `getClick` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2419
2419
|
}
|
|
2420
2420
|
},
|
|
2421
2421
|
"/api/v2/users_clicks/get/{click_id}": {
|
|
@@ -2447,7 +2447,7 @@
|
|
|
2447
2447
|
}
|
|
2448
2448
|
}
|
|
2449
2449
|
},
|
|
2450
|
-
"description": "Fetch a single click record. Read-only.\n\n**Required:** `click_id`.\n\n**See also:** `listClicks` (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._"
|
|
2450
|
+
"description": "Fetch a single click record. Read-only.\n\n**Use when:** rare — drilling into a specific click record by `click_id`. Most click-analytics work happens via `listClicks` with filters.\n\n**Required:** `click_id`.\n\n**See also:** `listClicks` (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._"
|
|
2451
2451
|
}
|
|
2452
2452
|
},
|
|
2453
2453
|
"/api/v2/users_clicks/create": {
|
|
@@ -2512,7 +2512,7 @@
|
|
|
2512
2512
|
}
|
|
2513
2513
|
}
|
|
2514
2514
|
},
|
|
2515
|
-
"description": "Create a new click record. Writes live data.\n\n**Required:** `user_id`, `click_type`, `click_name`, `click_from`, `click_url`.\n\n**Parameter interactions:**\n- `user_id` — the member profile being tracked\n- `click_type` — `link` (external), `phone` (reveal), or `email` (reveal)\n- `click_from` — source surface: `profile_page` or `search_results`\n- `click_url` — the URL that was clicked\n\n**See also:** `updateClick` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
2515
|
+
"description": "Create a new click record. Writes live data.\n\n**Use when:** replicating a click event from an external source (e.g., tracking clicks on a mirrored profile page on another domain). Usually not needed — BD auto-records clicks on its own surfaces.\n\n**Required:** `user_id`, `click_type`, `click_name`, `click_from`, `click_url`.\n\n**Parameter interactions:**\n- `user_id` — the member profile being tracked\n- `click_type` — `link` (external), `phone` (reveal), or `email` (reveal)\n- `click_from` — source surface: `profile_page` or `search_results`\n- `click_url` — the URL that was clicked\n\n**See also:** `updateClick` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
2516
2516
|
}
|
|
2517
2517
|
},
|
|
2518
2518
|
"/api/v2/users_clicks/update": {
|
|
@@ -2561,7 +2561,7 @@
|
|
|
2561
2561
|
}
|
|
2562
2562
|
}
|
|
2563
2563
|
},
|
|
2564
|
-
"description": "Update an existing click record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `click_id`.\n\n**See also:** `createClick` (add new), `deleteClick` (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._"
|
|
2564
|
+
"description": "Update an existing click record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** correcting click metadata. Rare — click records are typically append-only analytics.\n\n**Required:** `click_id`.\n\n**See also:** `createClick` (add new), `deleteClick` (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._"
|
|
2565
2565
|
}
|
|
2566
2566
|
},
|
|
2567
2567
|
"/api/v2/users_clicks/delete": {
|
|
@@ -2601,7 +2601,7 @@
|
|
|
2601
2601
|
}
|
|
2602
2602
|
}
|
|
2603
2603
|
},
|
|
2604
|
-
"description": "Permanently delete a click record by ID. Destructive — cannot be undone via API.\n\n**Required:** `click_id`.\n\n**See also:** `updateClick` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
2604
|
+
"description": "Permanently delete a click record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing test or spam click records from analytics. Does NOT affect the member's click counter if the site displays one.\n\n**Required:** `click_id`.\n\n**See also:** `updateClick` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
2605
2605
|
}
|
|
2606
2606
|
},
|
|
2607
2607
|
"/api/v2/leads/get": {
|
|
@@ -2637,7 +2637,7 @@
|
|
|
2637
2637
|
}
|
|
2638
2638
|
}
|
|
2639
2639
|
},
|
|
2640
|
-
"description": "Paginated enumeration of lead records. Read-only.\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.\n\n**See also:** `getLead` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2640
|
+
"description": "Paginated enumeration of lead records. Read-only.\n\n**Use when:** pulling the admin's lead inbox, generating lead reports, or iterating all leads to push into a CRM. For fetching one lead by ID use `getLead`.\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.\n\n**See also:** `getLead` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2641
2641
|
}
|
|
2642
2642
|
},
|
|
2643
2643
|
"/api/v2/leads/get/{lead_id}": {
|
|
@@ -2669,7 +2669,7 @@
|
|
|
2669
2669
|
}
|
|
2670
2670
|
}
|
|
2671
2671
|
},
|
|
2672
|
-
"description": "Fetch a single lead record. Read-only.\n\n**Required:** `lead_id`.\n\n**See also:** `listLeads` (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._"
|
|
2672
|
+
"description": "Fetch a single lead record. Read-only.\n\n**Use when:** handling one lead — viewing its details after a lead-notification email, following up in a CRM integration, or confirming the lead exists before calling `matchLead`.\n\n**Required:** `lead_id`.\n\n**See also:** `listLeads` (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._"
|
|
2673
2673
|
}
|
|
2674
2674
|
},
|
|
2675
2675
|
"/api/v2/leads/create": {
|
|
@@ -2730,14 +2730,14 @@
|
|
|
2730
2730
|
}
|
|
2731
2731
|
}
|
|
2732
2732
|
},
|
|
2733
|
-
"description": "Create a new lead record. Writes live data.\n\n**Required:** `lead_name`, `lead_email`, `lead_phone`, `lead_message`, `lead_location`, `top_id`.\n\n**Parameter interactions:**\n- `top_id` — category ID; discover via `listTopCategories`\n- All 6 required fields (`lead_name`, `lead_email`, `lead_phone`, `lead_message`, `lead_location`, `top_id`) must be supplied together\n- Response includes `lead_id` AND `token` — token may be needed for customer-facing URLs\n- After creating, call `matchLead` to trigger member notifications\n\n**See also:** `updateLead` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n**Operational rules (from BD support article 12000091106):**\n- `send_lead_email_notification=1` — activates lead email notifications to the site admin and/or matched members. Default is off: leads created via API are silent unless this flag is set. For the full auto-matching flow (finds members by category/location and emails them), call `matchLead` separately after creating the lead.\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._"
|
|
2733
|
+
"description": "Create a new lead record. Writes live data.\n\n**Use when:** importing leads from an external form, CSV, or web-scrape. Default is SILENT — no notification emails fire unless you pass `send_lead_email_notification=1`, and no member routing happens until you call `matchLead`. `top_id` (category) is required — look it up via `listTopCategories`.\n\n**Required:** `lead_name`, `lead_email`, `lead_phone`, `lead_message`, `lead_location`, `top_id`.\n\n**Parameter interactions:**\n- `top_id` — category ID; discover via `listTopCategories`\n- All 6 required fields (`lead_name`, `lead_email`, `lead_phone`, `lead_message`, `lead_location`, `top_id`) must be supplied together\n- Response includes `lead_id` AND `token` — token may be needed for customer-facing URLs\n- After creating, call `matchLead` to trigger member notifications\n\n**See also:** `updateLead` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n**Operational rules (from BD support article 12000091106):**\n- `send_lead_email_notification=1` — activates lead email notifications to the site admin and/or matched members. Default is off: leads created via API are silent unless this flag is set. For the full auto-matching flow (finds members by category/location and emails them), call `matchLead` separately after creating the lead.\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._"
|
|
2734
2734
|
}
|
|
2735
2735
|
},
|
|
2736
2736
|
"/api/v2/leads/match": {
|
|
2737
2737
|
"post": {
|
|
2738
2738
|
"operationId": "matchLead",
|
|
2739
2739
|
"summary": "Auto-match lead to members",
|
|
2740
|
-
"description": "Triggers automatic matching — system finds members matching category, location, and service area, then sends notification emails.\n\n**Required:** `lead_id`.\n\n**Parameter interactions:**\n- Side effect: sends notification emails to ALL members whose category, location, and service area match the lead\n- Not a dry-run — emails go out immediately. Not rate-limited per lead\n- `lead_id` must reference an existing lead created via `createLead`\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
2740
|
+
"description": "Triggers automatic matching — system finds members matching category, location, and service area, then sends notification emails.\n\n**Use when:** you've just created a lead (or need to re-distribute an existing one) and want BD to automatically email eligible members in matching category + location + service area. SIDE EFFECT: sends real emails to real members. Confirm with the user before calling on production data.\n\n**Required:** `lead_id`.\n\n**Parameter interactions:**\n- Side effect: sends notification emails to ALL members whose category, location, and service area match the lead\n- Not a dry-run — emails go out immediately. Not rate-limited per lead\n- `lead_id` must reference an existing lead created via `createLead`\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
2741
2741
|
"tags": [
|
|
2742
2742
|
"Leads"
|
|
2743
2743
|
],
|
|
@@ -2829,7 +2829,7 @@
|
|
|
2829
2829
|
}
|
|
2830
2830
|
}
|
|
2831
2831
|
},
|
|
2832
|
-
"description": "Update an existing lead record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `lead_id`.\n\n**Enums:** `lead_status`: `1`=Pending, `2`=Matched, `4`=Closed, `5`=Accepted, `6`=Declined, `7`=Expired, `8`=Archived.\n\n**See also:** `createLead` (add new), `deleteLead` (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._"
|
|
2832
|
+
"description": "Update an existing lead record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** adding admin notes to a lead, updating lead status, or correcting lead metadata. For deleting use `deleteLead`; for re-matching members use `matchLead`.\n\n**Required:** `lead_id`.\n\n**Enums:** `lead_status`: `1`=Pending, `2`=Matched, `4`=Closed, `5`=Accepted, `6`=Declined, `7`=Expired, `8`=Archived.\n\n**See also:** `createLead` (add new), `deleteLead` (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._"
|
|
2833
2833
|
}
|
|
2834
2834
|
},
|
|
2835
2835
|
"/api/v2/leads/delete": {
|
|
@@ -2869,7 +2869,7 @@
|
|
|
2869
2869
|
}
|
|
2870
2870
|
}
|
|
2871
2871
|
},
|
|
2872
|
-
"description": "Permanently delete a lead record by ID. Destructive — cannot be undone via API.\n\n**Required:** `lead_id`.\n\n**See also:** `updateLead` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
2872
|
+
"description": "Permanently delete a lead record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a spam or test lead. For preserving the lead but closing it, use `updateLead` with a status change instead.\n\n**Required:** `lead_id`.\n\n**See also:** `updateLead` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
2873
2873
|
}
|
|
2874
2874
|
},
|
|
2875
2875
|
"/api/v2/lead_matches/get": {
|
|
@@ -2899,7 +2899,7 @@
|
|
|
2899
2899
|
}
|
|
2900
2900
|
}
|
|
2901
2901
|
},
|
|
2902
|
-
"description": "Paginated enumeration of leadmatche records. Read-only.\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.\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2902
|
+
"description": "Paginated enumeration of leadmatche records. Read-only.\n\n**Use when:** auditing who got notified about which lead — useful for billing reports (paid-per-lead sites) or explaining to a member why they did/didn't receive a lead notification. Filter by `lead_id` to see all matches for one lead, or by `user_id` to see all leads a member received.\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.\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
2903
2903
|
}
|
|
2904
2904
|
},
|
|
2905
2905
|
"/api/v2/lead_matches/get/{match_id}": {
|
|
@@ -2931,7 +2931,7 @@
|
|
|
2931
2931
|
}
|
|
2932
2932
|
}
|
|
2933
2933
|
},
|
|
2934
|
-
"description": "Fetch a single leadmatch record. Read-only.\n\n**Required:** `match_id`.\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._"
|
|
2934
|
+
"description": "Fetch a single leadmatch record. Read-only.\n\n**Use when:** you have a specific `match_id` (from `listLeadMatches`) and need the full match row — lead points, price, response status, etc.\n\n**Required:** `match_id`.\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._"
|
|
2935
2935
|
}
|
|
2936
2936
|
},
|
|
2937
2937
|
"/api/v2/lead_matches/create": {
|
|
@@ -3036,7 +3036,7 @@
|
|
|
3036
3036
|
}
|
|
3037
3037
|
}
|
|
3038
3038
|
},
|
|
3039
|
-
"description": "Create a new leadmatch record. Writes live data.\n\n**Required:** `lead_id`, `user_id`, `lead_matched`, `lead_status`, `match_price`, `lead_token`, `lead_matched_by`, `lead_updated`.\n\n**Parameter interactions:**\n- Usually created automatically by `matchLead`; manual creation bypasses BD's matching logic\n- `lead_id` and `user_id` must both exist (use `getLead` / `getUser` to verify)\n- `lead_status` — match lifecycle state (see Enums)\n- `match_price`, `lead_points`, `lead_rating`, `lead_distance` — scoring fields used in ranking and billing\n\n**See also:** `updateLeadMatch` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
3039
|
+
"description": "Create a new leadmatch record. Writes live data.\n\n**Use when:** manually creating a lead↔member match BYPASSING BD's auto-matching. Rarely needed — usually `matchLead` handles this automatically. Use for data migrations, manual override scenarios, or replaying matches from another system.\n\n**Required:** `lead_id`, `user_id`, `lead_matched`, `lead_status`, `match_price`, `lead_token`, `lead_matched_by`, `lead_updated`.\n\n**Parameter interactions:**\n- Usually created automatically by `matchLead`; manual creation bypasses BD's matching logic\n- `lead_id` and `user_id` must both exist (use `getLead` / `getUser` to verify)\n- `lead_status` — match lifecycle state (see Enums)\n- `match_price`, `lead_points`, `lead_rating`, `lead_distance` — scoring fields used in ranking and billing\n\n**See also:** `updateLeadMatch` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
3040
3040
|
}
|
|
3041
3041
|
},
|
|
3042
3042
|
"/api/v2/lead_matches/update": {
|
|
@@ -3092,7 +3092,7 @@
|
|
|
3092
3092
|
}
|
|
3093
3093
|
}
|
|
3094
3094
|
},
|
|
3095
|
-
"description": "Update an existing leadmatch record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `match_id`.\n\n**Enums:** `lead_status`: `1`=Pending, `2`=Matched, `4`=Closed, `5`=Accepted, `6`=Declined, `7`=Expired, `8`=Archived.\n\n**See also:** `createLeadMatch` (add new), `deleteLeadMatch` (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._"
|
|
3095
|
+
"description": "Update an existing leadmatch record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** recording a member's response to a lead (`lead_response`, `lead_accepted`, `lead_chosen`) or adjusting `lead_points`/`match_price` for billing reconciliation.\n\n**Required:** `match_id`.\n\n**Enums:** `lead_status`: `1`=Pending, `2`=Matched, `4`=Closed, `5`=Accepted, `6`=Declined, `7`=Expired, `8`=Archived.\n\n**See also:** `createLeadMatch` (add new), `deleteLeadMatch` (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._"
|
|
3096
3096
|
}
|
|
3097
3097
|
},
|
|
3098
3098
|
"/api/v2/lead_matches/delete": {
|
|
@@ -3132,7 +3132,7 @@
|
|
|
3132
3132
|
}
|
|
3133
3133
|
}
|
|
3134
3134
|
},
|
|
3135
|
-
"description": "Permanently delete a leadmatch record by ID. Destructive — cannot be undone via API.\n\n**Required:** `match_id`.\n\n**See also:** `updateLeadMatch` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3135
|
+
"description": "Permanently delete a leadmatch record by ID. Destructive — cannot be undone via API.\n\n**Use when:** cleaning up an erroneous match (e.g., test data) or removing a match that was auto-created but shouldn't exist. Does NOT unsend the notification email that may have already fired.\n\n**Required:** `match_id`.\n\n**See also:** `updateLeadMatch` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3136
3136
|
}
|
|
3137
3137
|
},
|
|
3138
3138
|
"/api/v2/data_posts/get": {
|
|
@@ -3168,7 +3168,7 @@
|
|
|
3168
3168
|
}
|
|
3169
3169
|
}
|
|
3170
3170
|
},
|
|
3171
|
-
"description": "Paginated enumeration of post records. Read-only.\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.\n\n**See also:** `getSingleImagePost` (single record by ID), `searchSingleImagePosts` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
3171
|
+
"description": "Paginated enumeration of post records. Read-only.\n\n**Use when:** enumerating posts of single-image families — blog articles, events, jobs, coupons, videos, discussions. Filter by `user_id` for one member's posts, or `data_id` to scope to one post type. Before using, confirm the target post type has `data_type` 9 or 20 (single-image); `data_type=4` means multi-image and you want `listMultiImagePosts` instead.\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.\n\n**See also:** `getSingleImagePost` (single record by ID), `searchSingleImagePosts` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
3172
3172
|
}
|
|
3173
3173
|
},
|
|
3174
3174
|
"/api/v2/data_posts/get/{post_id}": {
|
|
@@ -3200,14 +3200,14 @@
|
|
|
3200
3200
|
}
|
|
3201
3201
|
}
|
|
3202
3202
|
},
|
|
3203
|
-
"description": "Fetch a single post record. Read-only.\n\n**Required:** `post_id`.\n\n**See also:** `listSingleImagePosts` (enumerate many), `searchSingleImagePosts` (keyword search).\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._"
|
|
3203
|
+
"description": "Fetch a single post record. Read-only.\n\n**Use when:** fetching one post by `post_id`. For enumeration use `listSingleImagePosts`; for keyword search use `searchSingleImagePosts`.\n\n**Required:** `post_id`.\n\n**See also:** `listSingleImagePosts` (enumerate many), `searchSingleImagePosts` (keyword search).\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._"
|
|
3204
3204
|
}
|
|
3205
3205
|
},
|
|
3206
3206
|
"/api/v2/data_posts/fields": {
|
|
3207
3207
|
"get": {
|
|
3208
3208
|
"operationId": "getSingleImagePostFields",
|
|
3209
3209
|
"summary": "Get post field definitions",
|
|
3210
|
-
"description": "Returns custom fields for a specific post type form.\n\n**Required:** `form_name`.\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._",
|
|
3210
|
+
"description": "Returns custom fields for a specific post type form.\n\n**Use when:** discovering the per-post-type custom fields before building a create/update payload. Pass `form_name` of the target post type.\n\n**Required:** `form_name`.\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._",
|
|
3211
3211
|
"tags": [
|
|
3212
3212
|
"Posts"
|
|
3213
3213
|
],
|
|
@@ -3312,7 +3312,7 @@
|
|
|
3312
3312
|
}
|
|
3313
3313
|
}
|
|
3314
3314
|
},
|
|
3315
|
-
"description": "Create a new post record. Writes live data.\n\n**Required:** `user_id`, `data_id`, `data_type`.\n\n**Parameter interactions:**\n- `user_id` — owner; must be an existing member (discover via `listUsers` or `searchUsers`)\n- `data_id` — post type category ID; get via `listPostTypes`\n- `data_type` — data type classification; usually matches the post type's data type\n- `post_status`: `0`=Draft (not visible), `1`=Published (public)\n- Response includes both `post_id` and `post_token` — the token is used for sharable URLs\n\n**See also:** `updateSingleImagePost` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n---\n\n**Which endpoint to use — `data_type` family decides:**\n\nEvery post type in `data_categories` has a `data_type` field that classifies its family. Call `listPostTypes` or `getPostType` to see the `data_type` of your target post type, then choose:\n\n| `data_type` value | Family | Use endpoint |\n|---|---|---|\n| `4` | Multi-image (albums, galleries, photo-heavy listings — e.g. Classified, Photo Album, Property, Product) | `createMultiImagePost` |\n| `9` | Single-image video | `createSingleImagePost` |\n| `20` | Single-image article / event / blog / job / coupon | `createSingleImagePost` |\n| `10`, `13`, `21`, `29` (and similar) | Internal admin types (Member Listings, Reviews, Specialties, Favorites) — NOT posts | Use the resource-specific endpoint (e.g. `createReview` for `data_type=13`) |\n\nIf you call the wrong create endpoint for a given post type, BD may accept the row but it won't render on the public site correctly.\n\n**For \"make a blog post\" intent:** look up `data_categories` for `data_name` matching \"blog\" (commonly `data_id=14` with `data_type=20`) → `createSingleImagePost` with that `data_id` + `data_type`.\n\n**For \"make a photo album\" / \"gallery\" intent:** look up the album post type (often `data_id=10`, `data_type=4`) → `createMultiImagePost` with that `data_id` + `data_type`. Photos are added separately via `createMultiImagePostPhoto` using the returned `group_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._"
|
|
3315
|
+
"description": "Create a new post record. Writes live data.\n\n**Use when:** creating a blog article, event, job listing, coupon, or any other single-image post type. Look up `data_id` + `data_type` via `listPostTypes` first — the post type's `data_type` field determines which create endpoint is correct. If `data_type=4` on the post type, use `createMultiImagePost` instead. For posts with scraped external image URLs, include `auto_image_import=1` to fetch and store them locally.\n\n**Required:** `user_id`, `data_id`, `data_type`.\n\n**Parameter interactions:**\n- `user_id` — owner; must be an existing member (discover via `listUsers` or `searchUsers`)\n- `data_id` — post type category ID; get via `listPostTypes`\n- `data_type` — data type classification; usually matches the post type's data type\n- `post_status`: `0`=Draft (not visible), `1`=Published (public)\n- Response includes both `post_id` and `post_token` — the token is used for sharable URLs\n\n**See also:** `updateSingleImagePost` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n---\n\n**Which endpoint to use — `data_type` family decides:**\n\nEvery post type in `data_categories` has a `data_type` field that classifies its family. Call `listPostTypes` or `getPostType` to see the `data_type` of your target post type, then choose:\n\n| `data_type` value | Family | Use endpoint |\n|---|---|---|\n| `4` | Multi-image (albums, galleries, photo-heavy listings — e.g. Classified, Photo Album, Property, Product) | `createMultiImagePost` |\n| `9` | Single-image video | `createSingleImagePost` |\n| `20` | Single-image article / event / blog / job / coupon | `createSingleImagePost` |\n| `10`, `13`, `21`, `29` (and similar) | Internal admin types (Member Listings, Reviews, Specialties, Favorites) — NOT posts | Use the resource-specific endpoint (e.g. `createReview` for `data_type=13`) |\n\nIf you call the wrong create endpoint for a given post type, BD may accept the row but it won't render on the public site correctly.\n\n**For \"make a blog post\" intent:** look up `data_categories` for `data_name` matching \"blog\" (commonly `data_id=14` with `data_type=20`) → `createSingleImagePost` with that `data_id` + `data_type`.\n\n**For \"make a photo album\" / \"gallery\" intent:** look up the album post type (often `data_id=10`, `data_type=4`) → `createMultiImagePost` with that `data_id` + `data_type`. Photos are added separately via `createMultiImagePostPhoto` using the returned `group_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._"
|
|
3316
3316
|
}
|
|
3317
3317
|
},
|
|
3318
3318
|
"/api/v2/data_posts/update": {
|
|
@@ -3366,7 +3366,7 @@
|
|
|
3366
3366
|
}
|
|
3367
3367
|
}
|
|
3368
3368
|
},
|
|
3369
|
-
"description": "Update an existing post record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `post_id`.\n\n**Enums:** `post_status`: `0`=Draft (saved but not publicly visible), `1`=Published (publicly visible on the site).\n\n**See also:** `createSingleImagePost` (add new), `deleteSingleImagePost` (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._"
|
|
3369
|
+
"description": "Update an existing post record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** editing post content, switching from draft to published (`post_status=0`→`1`), updating post title/caption, or correcting post metadata. To move a post to a different post type (rare), pass `data_id` — but validate the new post type is still in the single-image family.\n\n**Required:** `post_id`.\n\n**Enums:** `post_status`: `0`=Draft (saved but not publicly visible), `1`=Published (publicly visible on the site).\n\n**See also:** `createSingleImagePost` (add new), `deleteSingleImagePost` (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._"
|
|
3370
3370
|
}
|
|
3371
3371
|
},
|
|
3372
3372
|
"/api/v2/data_posts/delete": {
|
|
@@ -3406,7 +3406,7 @@
|
|
|
3406
3406
|
}
|
|
3407
3407
|
}
|
|
3408
3408
|
},
|
|
3409
|
-
"description": "Permanently delete a post record by ID. Destructive — cannot be undone via API.\n\n**Required:** `post_id`.\n\n**See also:** `updateSingleImagePost` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3409
|
+
"description": "Permanently delete a post record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a post permanently. For \"hide without deleting\" use `updateSingleImagePost` with `post_status=0` (Draft). Deleting also removes the post_token, breaking any external links to the share URL.\n\n**Required:** `post_id`.\n\n**See also:** `updateSingleImagePost` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3410
3410
|
}
|
|
3411
3411
|
},
|
|
3412
3412
|
"/api/v2/data_posts/search": {
|
|
@@ -3458,7 +3458,7 @@
|
|
|
3458
3458
|
}
|
|
3459
3459
|
}
|
|
3460
3460
|
},
|
|
3461
|
-
"description": "Keyword search across post records. Read-only.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**Parameter interactions:**\n- `data_id` (post type) is strongly recommended — results vary significantly by post type configuration\n- `q` — keyword across post title, caption, content\n- Fields exposed in search depend on the post type; use `getSingleImagePostFields` with `form_name` to discover them\n\n**See also:** `getSingleImagePost` (single record by ID), `listSingleImagePosts` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\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._"
|
|
3461
|
+
"description": "Keyword search across post records. Read-only.\n\n**Use when:** an admin or agent wants to find a post by keyword or title. Pass `data_id` to scope search to one post type — strongly recommended since results depend on per-post-type configuration.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**Parameter interactions:**\n- `data_id` (post type) is strongly recommended — results vary significantly by post type configuration\n- `q` — keyword across post title, caption, content\n- Fields exposed in search depend on the post type; use `getSingleImagePostFields` with `form_name` to discover them\n\n**See also:** `getSingleImagePost` (single record by ID), `listSingleImagePosts` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\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._"
|
|
3462
3462
|
}
|
|
3463
3463
|
},
|
|
3464
3464
|
"/api/v2/users_portfolio_groups/get": {
|
|
@@ -3494,7 +3494,7 @@
|
|
|
3494
3494
|
}
|
|
3495
3495
|
}
|
|
3496
3496
|
},
|
|
3497
|
-
"description": "Paginated enumeration of portfoliogroup records. Read-only.\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.\n\n**See also:** `getMultiImagePost` (single record by ID), `searchMultiImagePosts` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
3497
|
+
"description": "Paginated enumeration of portfoliogroup records. Read-only.\n\n**Use when:** enumerating photo-album / gallery-style posts (Photo Album, Classified, Property, Product — any post type with `data_type=4`). For single-image post types use `listSingleImagePosts`.\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.\n\n**See also:** `getMultiImagePost` (single record by ID), `searchMultiImagePosts` (keyword search).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
3498
3498
|
}
|
|
3499
3499
|
},
|
|
3500
3500
|
"/api/v2/users_portfolio_groups/get/{group_id}": {
|
|
@@ -3526,7 +3526,7 @@
|
|
|
3526
3526
|
}
|
|
3527
3527
|
}
|
|
3528
3528
|
},
|
|
3529
|
-
"description": "Fetch a single portfoliogroup record. Read-only.\n\n**Required:** `group_id`.\n\n**See also:** `listMultiImagePosts` (enumerate many), `searchMultiImagePosts` (keyword search).\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._"
|
|
3529
|
+
"description": "Fetch a single portfoliogroup record. Read-only.\n\n**Use when:** fetching one multi-image post by `group_id`. Photos in this post are loaded separately via `listMultiImagePostPhotos` with `group_id` filter.\n\n**Required:** `group_id`.\n\n**See also:** `listMultiImagePosts` (enumerate many), `searchMultiImagePosts` (keyword search).\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._"
|
|
3530
3530
|
}
|
|
3531
3531
|
},
|
|
3532
3532
|
"/api/v2/users_portfolio_groups/fields": {
|
|
@@ -3558,7 +3558,7 @@
|
|
|
3558
3558
|
}
|
|
3559
3559
|
}
|
|
3560
3560
|
},
|
|
3561
|
-
"description": "Fetch a single portfoliogroupfields record. Read-only.\n\n**Required:** `form_name`.\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._"
|
|
3561
|
+
"description": "Fetch a single portfoliogroupfields record. Read-only.\n\n**Use when:** discovering per-post-type custom fields for multi-image posts — same pattern as `getSingleImagePostFields` but for the `users_portfolio_groups` resource.\n\n**Required:** `form_name`.\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._"
|
|
3562
3562
|
}
|
|
3563
3563
|
},
|
|
3564
3564
|
"/api/v2/users_portfolio_groups/create": {
|
|
@@ -3628,7 +3628,7 @@
|
|
|
3628
3628
|
}
|
|
3629
3629
|
}
|
|
3630
3630
|
},
|
|
3631
|
-
"description": "Create a new portfoliogroup record. Writes live data.\n\n**Required:** `user_id`, `data_id`, `data_type`.\n\n**Parameter interactions:**\n- `data_id` + `data_type` — specify the post type this album belongs to (from `listPostTypes` / `listDataTypes`)\n- `group_status`: `0`=Hidden, `1`=Published\n- Photos are added separately via `createMultiImagePostPhoto` using the returned `group_id`\n\n**See also:** `updateMultiImagePost` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n---\n\n**Which endpoint to use — `data_type` family decides:**\n\nEvery post type in `data_categories` has a `data_type` field that classifies its family. Call `listPostTypes` or `getPostType` to see the `data_type` of your target post type, then choose:\n\n| `data_type` value | Family | Use endpoint |\n|---|---|---|\n| `4` | Multi-image (albums, galleries, photo-heavy listings — e.g. Classified, Photo Album, Property, Product) | `createMultiImagePost` |\n| `9` | Single-image video | `createSingleImagePost` |\n| `20` | Single-image article / event / blog / job / coupon | `createSingleImagePost` |\n| `10`, `13`, `21`, `29` (and similar) | Internal admin types (Member Listings, Reviews, Specialties, Favorites) — NOT posts | Use the resource-specific endpoint (e.g. `createReview` for `data_type=13`) |\n\nIf you call the wrong create endpoint for a given post type, BD may accept the row but it won't render on the public site correctly.\n\n**For \"make a blog post\" intent:** look up `data_categories` for `data_name` matching \"blog\" (commonly `data_id=14` with `data_type=20`) → `createSingleImagePost` with that `data_id` + `data_type`.\n\n**For \"make a photo album\" / \"gallery\" intent:** look up the album post type (often `data_id=10`, `data_type=4`) → `createMultiImagePost` with that `data_id` + `data_type`. Photos are added separately via `createMultiImagePostPhoto` using the returned `group_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._"
|
|
3631
|
+
"description": "Create a new portfoliogroup record. Writes live data.\n\n**Use when:** creating a photo album, gallery, product listing with multiple photos, or any post type with `data_type=4`. Confirm the target post type's `data_type` via `listPostTypes` first — `data_type=4` belongs here; 9/20 belongs in `createSingleImagePost`. After create, add photos one-by-one with `createMultiImagePostPhoto` using the returned `group_id`. For scraped image URLs, include `auto_image_import=1`.\n\n**Required:** `user_id`, `data_id`, `data_type`.\n\n**Parameter interactions:**\n- `data_id` + `data_type` — specify the post type this album belongs to (from `listPostTypes` / `listDataTypes`)\n- `group_status`: `0`=Hidden, `1`=Published\n- Photos are added separately via `createMultiImagePostPhoto` using the returned `group_id`\n\n**See also:** `updateMultiImagePost` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n---\n\n**Which endpoint to use — `data_type` family decides:**\n\nEvery post type in `data_categories` has a `data_type` field that classifies its family. Call `listPostTypes` or `getPostType` to see the `data_type` of your target post type, then choose:\n\n| `data_type` value | Family | Use endpoint |\n|---|---|---|\n| `4` | Multi-image (albums, galleries, photo-heavy listings — e.g. Classified, Photo Album, Property, Product) | `createMultiImagePost` |\n| `9` | Single-image video | `createSingleImagePost` |\n| `20` | Single-image article / event / blog / job / coupon | `createSingleImagePost` |\n| `10`, `13`, `21`, `29` (and similar) | Internal admin types (Member Listings, Reviews, Specialties, Favorites) — NOT posts | Use the resource-specific endpoint (e.g. `createReview` for `data_type=13`) |\n\nIf you call the wrong create endpoint for a given post type, BD may accept the row but it won't render on the public site correctly.\n\n**For \"make a blog post\" intent:** look up `data_categories` for `data_name` matching \"blog\" (commonly `data_id=14` with `data_type=20`) → `createSingleImagePost` with that `data_id` + `data_type`.\n\n**For \"make a photo album\" / \"gallery\" intent:** look up the album post type (often `data_id=10`, `data_type=4`) → `createMultiImagePost` with that `data_id` + `data_type`. Photos are added separately via `createMultiImagePostPhoto` using the returned `group_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._"
|
|
3632
3632
|
}
|
|
3633
3633
|
},
|
|
3634
3634
|
"/api/v2/users_portfolio_groups/update": {
|
|
@@ -3682,7 +3682,7 @@
|
|
|
3682
3682
|
}
|
|
3683
3683
|
}
|
|
3684
3684
|
},
|
|
3685
|
-
"description": "Update an existing portfoliogroup record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `group_id`.\n\n**Enums:** `group_status`: `0`=Draft (saved but not publicly visible), `1`=Published (publicly visible on the site).\n\n**See also:** `createMultiImagePost` (add new), `deleteMultiImagePost` (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._"
|
|
3685
|
+
"description": "Update an existing portfoliogroup record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** editing the album metadata (title, description, `group_status`). Photos within are edited individually via `updateMultiImagePostPhoto`.\n\n**Required:** `group_id`.\n\n**Enums:** `group_status`: `0`=Draft (saved but not publicly visible), `1`=Published (publicly visible on the site).\n\n**See also:** `createMultiImagePost` (add new), `deleteMultiImagePost` (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._"
|
|
3686
3686
|
}
|
|
3687
3687
|
},
|
|
3688
3688
|
"/api/v2/users_portfolio_groups/delete": {
|
|
@@ -3722,7 +3722,7 @@
|
|
|
3722
3722
|
}
|
|
3723
3723
|
}
|
|
3724
3724
|
},
|
|
3725
|
-
"description": "Permanently delete a portfoliogroup record by ID. Destructive — cannot be undone via API.\n\n**Required:** `group_id`.\n\n**See also:** `updateMultiImagePost` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3725
|
+
"description": "Permanently delete a portfoliogroup record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing the entire album. Contained photos (`users_portfolio` rows with matching `group_id`) become orphaned — delete them first if strict cleanup matters.\n\n**Required:** `group_id`.\n\n**See also:** `updateMultiImagePost` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3726
3726
|
}
|
|
3727
3727
|
},
|
|
3728
3728
|
"/api/v2/users_portfolio_groups/search": {
|
|
@@ -3761,7 +3761,7 @@
|
|
|
3761
3761
|
}
|
|
3762
3762
|
}
|
|
3763
3763
|
},
|
|
3764
|
-
"description": "Keyword search across portfoliogroup records. Read-only.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**See also:** `getMultiImagePost` (single record by ID), `listMultiImagePosts` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\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._"
|
|
3764
|
+
"description": "Keyword search across portfoliogroup records. Read-only.\n\n**Use when:** searching multi-image posts by keyword. Pass `data_id` to scope to one multi-image post type.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` to paginate large result sets.\n\n**See also:** `getMultiImagePost` (single record by ID), `listMultiImagePosts` (full enumeration).\n\n**Returns:** `{ status: \"success\", message: [...records] }`. Supports pagination fields when result set is large.\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._"
|
|
3765
3765
|
}
|
|
3766
3766
|
},
|
|
3767
3767
|
"/api/v2/users_portfolio/get": {
|
|
@@ -3797,7 +3797,7 @@
|
|
|
3797
3797
|
}
|
|
3798
3798
|
}
|
|
3799
3799
|
},
|
|
3800
|
-
"description": "Paginated enumeration of portfoliophoto records. Read-only.\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.\n\n**See also:** `getMultiImagePostPhoto` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
3800
|
+
"description": "Paginated enumeration of portfoliophoto records. Read-only.\n\n**Use when:** fetching all photos within a multi-image post — always pass `group_id` to filter. For a single photo by ID use `getMultiImagePostPhoto`.\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.\n\n**See also:** `getMultiImagePostPhoto` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
3801
3801
|
}
|
|
3802
3802
|
},
|
|
3803
3803
|
"/api/v2/users_portfolio/get/{photo_id}": {
|
|
@@ -3829,7 +3829,7 @@
|
|
|
3829
3829
|
}
|
|
3830
3830
|
}
|
|
3831
3831
|
},
|
|
3832
|
-
"description": "Fetch a single portfoliophoto record. Read-only.\n\n**Required:** `photo_id`.\n\n**See also:** `listMultiImagePostPhotos` (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._"
|
|
3832
|
+
"description": "Fetch a single portfoliophoto record. Read-only.\n\n**Use when:** editing or removing one specific photo within an album. You need the `photo_id` (from `listMultiImagePostPhotos`).\n\n**Required:** `photo_id`.\n\n**See also:** `listMultiImagePostPhotos` (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._"
|
|
3833
3833
|
}
|
|
3834
3834
|
},
|
|
3835
3835
|
"/api/v2/users_portfolio/create": {
|
|
@@ -3886,7 +3886,7 @@
|
|
|
3886
3886
|
}
|
|
3887
3887
|
}
|
|
3888
3888
|
},
|
|
3889
|
-
"description": "Create a new portfoliophoto record. Writes live data.\n\n**Required:** `user_id`, `group_id`.\n\n**Parameter interactions:**\n- `group_id` — parent album group (from `createMultiImagePost` or `listMultiImagePosts`)\n- `original_image_url` — full URL of the image; must already be publicly accessible\n- `status`: `0`=Hidden, `1`=Active\n\n**See also:** `updateMultiImagePostPhoto` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
3889
|
+
"description": "Create a new portfoliophoto record. Writes live data.\n\n**Use when:** adding an image to an existing multi-image post. The parent post must already exist (call `createMultiImagePost` first to get the `group_id`). For scraped URLs, ensure `auto_image_import` was set on the parent.\n\n**Required:** `user_id`, `group_id`.\n\n**Parameter interactions:**\n- `group_id` — parent album group (from `createMultiImagePost` or `listMultiImagePosts`)\n- `original_image_url` — full URL of the image; must already be publicly accessible\n- `status`: `0`=Hidden, `1`=Active\n\n**See also:** `updateMultiImagePostPhoto` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
3890
3890
|
}
|
|
3891
3891
|
},
|
|
3892
3892
|
"/api/v2/users_portfolio/update": {
|
|
@@ -3932,7 +3932,7 @@
|
|
|
3932
3932
|
}
|
|
3933
3933
|
}
|
|
3934
3934
|
},
|
|
3935
|
-
"description": "Update an existing portfoliophoto record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `photo_id`.\n\n**See also:** `createMultiImagePostPhoto` (add new), `deleteMultiImagePostPhoto` (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._"
|
|
3935
|
+
"description": "Update an existing portfoliophoto record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** reordering photos within an album (`order` field), renaming, or hiding a photo (`status=0`) without deleting.\n\n**Required:** `photo_id`.\n\n**See also:** `createMultiImagePostPhoto` (add new), `deleteMultiImagePostPhoto` (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._"
|
|
3936
3936
|
}
|
|
3937
3937
|
},
|
|
3938
3938
|
"/api/v2/users_portfolio/delete": {
|
|
@@ -3972,7 +3972,7 @@
|
|
|
3972
3972
|
}
|
|
3973
3973
|
}
|
|
3974
3974
|
},
|
|
3975
|
-
"description": "Permanently delete a portfoliophoto record by ID. Destructive — cannot be undone via API.\n\n**Required:** `photo_id`.\n\n**See also:** `updateMultiImagePostPhoto` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3975
|
+
"description": "Permanently delete a portfoliophoto record by ID. Destructive — cannot be undone via API.\n\n**Use when:** permanently removing one photo from an album. For \"hide\" use `updateMultiImagePostPhoto` with `status=0`.\n\n**Required:** `photo_id`.\n\n**See also:** `updateMultiImagePostPhoto` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
3976
3976
|
}
|
|
3977
3977
|
},
|
|
3978
3978
|
"/api/v2/data_categories/get": {
|
|
@@ -4008,7 +4008,7 @@
|
|
|
4008
4008
|
}
|
|
4009
4009
|
}
|
|
4010
4010
|
},
|
|
4011
|
-
"description": "Paginated enumeration of posttype records. Read-only.\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.\n\n**See also:** `getPostType` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4011
|
+
"description": "Paginated enumeration of posttype records. Read-only.\n\n**Use when:** discovering which post types exist on this site AND their `data_type` families. The `data_type` value on each row tells you whether a post type belongs to `createSingleImagePost` (9/20) or `createMultiImagePost` (4). Use this BEFORE calling either create endpoint to pick the correct tool.\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.\n\n**See also:** `getPostType` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4012
4012
|
}
|
|
4013
4013
|
},
|
|
4014
4014
|
"/api/v2/data_categories/get/{data_id}": {
|
|
@@ -4040,7 +4040,7 @@
|
|
|
4040
4040
|
}
|
|
4041
4041
|
}
|
|
4042
4042
|
},
|
|
4043
|
-
"description": "Fetch a single posttype record. Read-only.\n\n**Required:** `data_id`.\n\n**See also:** `listPostTypes` (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._"
|
|
4043
|
+
"description": "Fetch a single posttype record. Read-only.\n\n**Use when:** checking the configuration of one post type (which `data_type` family, whether active, custom field config). Commonly followed by `getPostTypeCustomFields` to enumerate per-type fields.\n\n**Required:** `data_id`.\n\n**See also:** `listPostTypes` (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._"
|
|
4044
4044
|
}
|
|
4045
4045
|
},
|
|
4046
4046
|
"/api/v2/data_categories/create": {
|
|
@@ -4093,7 +4093,7 @@
|
|
|
4093
4093
|
}
|
|
4094
4094
|
}
|
|
4095
4095
|
},
|
|
4096
|
-
"description": "Create a new posttype record. Writes live data.\n\n**Required:** `data_name`.\n\n**Enums:** `data_active`: `0`=Inactive, `1`=Active.\n\n**See also:** `updatePostType` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4096
|
+
"description": "Create a new posttype record. Writes live data.\n\n**Use when:** adding a new content type to the site (e.g., \"Podcasts\"). Rare — most sites use BD's built-in post types. Requires admin-level changes to custom fields afterward.\n\n**Required:** `data_name`.\n\n**Enums:** `data_active`: `0`=Inactive, `1`=Active.\n\n**See also:** `updatePostType` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4097
4097
|
}
|
|
4098
4098
|
},
|
|
4099
4099
|
"/api/v2/data_categories/custom_fields": {
|
|
@@ -4133,7 +4133,7 @@
|
|
|
4133
4133
|
}
|
|
4134
4134
|
}
|
|
4135
4135
|
},
|
|
4136
|
-
"description": "Fetch a single posttypecustomfields record. Read-only.\n\n**Required:** `data_id`.\n\n**Parameter interactions:**\n- `data_id` — the post type to introspect; get via `listPostTypes`\n- Returns custom field definitions specific to this post type — use to build create/update payloads for matching posts\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._"
|
|
4136
|
+
"description": "Fetch a single posttypecustomfields record. Read-only.\n\n**Use when:** building a create/update payload for a post type that has custom fields (most do). Returns the exact per-type schema to send. Pass `data_id` of the target post type.\n\n**Required:** `data_id`.\n\n**Parameter interactions:**\n- `data_id` — the post type to introspect; get via `listPostTypes`\n- Returns custom field definitions specific to this post type — use to build create/update payloads for matching posts\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._"
|
|
4137
4137
|
}
|
|
4138
4138
|
},
|
|
4139
4139
|
"/api/v2/data_categories/update": {
|
|
@@ -4179,7 +4179,7 @@
|
|
|
4179
4179
|
}
|
|
4180
4180
|
}
|
|
4181
4181
|
},
|
|
4182
|
-
"description": "Update an existing posttype record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `data_id`.\n\n**See also:** `createPostType` (add new), `deletePostType` (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._"
|
|
4182
|
+
"description": "Update an existing posttype record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** toggling a post type active/inactive, renaming, or changing per-page display counts. For custom-field changes you typically work in the BD admin UI.\n\n**Required:** `data_id`.\n\n**See also:** `createPostType` (add new), `deletePostType` (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._"
|
|
4183
4183
|
}
|
|
4184
4184
|
},
|
|
4185
4185
|
"/api/v2/data_categories/delete": {
|
|
@@ -4219,7 +4219,7 @@
|
|
|
4219
4219
|
}
|
|
4220
4220
|
}
|
|
4221
4221
|
},
|
|
4222
|
-
"description": "Permanently delete a posttype record by ID. Destructive — cannot be undone via API.\n\n**Required:** `data_id`.\n\n**See also:** `updatePostType` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
4222
|
+
"description": "Permanently delete a posttype record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a post type entirely. Existing posts of this type become orphaned — consider migrating them to another type first via a bulk `updateSingleImagePost`/`updateMultiImagePost`.\n\n**Required:** `data_id`.\n\n**See also:** `updatePostType` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
4223
4223
|
}
|
|
4224
4224
|
},
|
|
4225
4225
|
"/api/v2/unsubscribe_list/get": {
|
|
@@ -4249,7 +4249,7 @@
|
|
|
4249
4249
|
}
|
|
4250
4250
|
}
|
|
4251
4251
|
},
|
|
4252
|
-
"description": "Paginated enumeration of unsubscribe records. Read-only.\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.\n\n**See also:** `getUnsubscribe` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4252
|
+
"description": "Paginated enumeration of unsubscribe records. Read-only.\n\n**Use when:** auditing the email unsubscribe list — useful for compliance (GDPR, CAN-SPAM) or before launching a new email campaign.\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.\n\n**See also:** `getUnsubscribe` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4253
4253
|
}
|
|
4254
4254
|
},
|
|
4255
4255
|
"/api/v2/unsubscribe_list/get/{id}": {
|
|
@@ -4281,7 +4281,7 @@
|
|
|
4281
4281
|
}
|
|
4282
4282
|
}
|
|
4283
4283
|
},
|
|
4284
|
-
"description": "Fetch a single unsubscribe record. Read-only.\n\n**Required:** `id`.\n\n**See also:** `listUnsubscribes` (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._"
|
|
4284
|
+
"description": "Fetch a single unsubscribe record. Read-only.\n\n**Use when:** checking one unsubscribe record by ID.\n\n**Required:** `id`.\n\n**See also:** `listUnsubscribes` (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._"
|
|
4285
4285
|
}
|
|
4286
4286
|
},
|
|
4287
4287
|
"/api/v2/unsubscribe_list/create": {
|
|
@@ -4330,7 +4330,7 @@
|
|
|
4330
4330
|
}
|
|
4331
4331
|
}
|
|
4332
4332
|
},
|
|
4333
|
-
"description": "Create a new unsubscribe record. Writes live data.\n\n**Required:** `email`.\n\n**Enums:** `definitive`: `0`, `1`.\n\n**See also:** `updateUnsubscribe` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4333
|
+
"description": "Create a new unsubscribe record. Writes live data.\n\n**Use when:** programmatically opting a member out of emails (e.g., from an external unsubscribe form or CRM sync). BD adds entries itself when members click email unsubscribe links.\n\n**Required:** `email`.\n\n**Enums:** `definitive`: `0`, `1`.\n\n**See also:** `updateUnsubscribe` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4334
4334
|
}
|
|
4335
4335
|
},
|
|
4336
4336
|
"/api/v2/unsubscribe_list/update": {
|
|
@@ -4377,14 +4377,14 @@
|
|
|
4377
4377
|
}
|
|
4378
4378
|
}
|
|
4379
4379
|
},
|
|
4380
|
-
"description": "Update an existing unsubscribe record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `id`.\n\n**Enums:** `definitive`: `0`, `1`.\n\n**See also:** `createUnsubscribe` (add new), `deleteUnsubscribe` (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._"
|
|
4380
|
+
"description": "Update an existing unsubscribe record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** editing an unsubscribe record. Rare.\n\n**Required:** `id`.\n\n**Enums:** `definitive`: `0`, `1`.\n\n**See also:** `createUnsubscribe` (add new), `deleteUnsubscribe` (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._"
|
|
4381
4381
|
}
|
|
4382
4382
|
},
|
|
4383
4383
|
"/api/v2/unsubscribe_list/delete": {
|
|
4384
4384
|
"delete": {
|
|
4385
4385
|
"operationId": "deleteUnsubscribe",
|
|
4386
4386
|
"summary": "Remove email from unsubscribe list",
|
|
4387
|
-
"description": "Permanently delete a unsubscribe record by ID. Destructive — cannot be undone via API.\n\n**Required:** `id`.\n\n**See also:** `updateUnsubscribe` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._",
|
|
4387
|
+
"description": "Permanently delete a unsubscribe record by ID. Destructive — cannot be undone via API.\n\n**Use when:** re-subscribing a member (remove their unsubscribe entry). Confirm the member's consent first — don't use to silently re-enable emails.\n\n**Required:** `id`.\n\n**See also:** `updateUnsubscribe` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._",
|
|
4388
4388
|
"tags": [
|
|
4389
4389
|
"Unsubscribe"
|
|
4390
4390
|
],
|
|
@@ -4447,7 +4447,7 @@
|
|
|
4447
4447
|
}
|
|
4448
4448
|
}
|
|
4449
4449
|
},
|
|
4450
|
-
"description": "Paginated enumeration of widget records. Read-only.\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.\n\n**See also:** `getWidget` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4450
|
+
"description": "Paginated enumeration of widget records. Read-only.\n\n**Use when:** discovering the reusable HTML components available for embedding in pages (`[widget=Name]` shortcode) or email templates.\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.\n\n**See also:** `getWidget` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4451
4451
|
}
|
|
4452
4452
|
},
|
|
4453
4453
|
"/api/v2/data_widgets/get/{widget_id}": {
|
|
@@ -4479,7 +4479,7 @@
|
|
|
4479
4479
|
}
|
|
4480
4480
|
}
|
|
4481
4481
|
},
|
|
4482
|
-
"description": "Fetch a single widget record. Read-only.\n\n**Required:** `widget_id`.\n\n**See also:** `listWidgets` (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._"
|
|
4482
|
+
"description": "Fetch a single widget record. Read-only.\n\n**Use when:** fetching one widget's HTML source for edit.\n\n**Required:** `widget_id`.\n\n**See also:** `listWidgets` (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._"
|
|
4483
4483
|
}
|
|
4484
4484
|
},
|
|
4485
4485
|
"/api/v2/data_widgets/create": {
|
|
@@ -4538,7 +4538,7 @@
|
|
|
4538
4538
|
}
|
|
4539
4539
|
}
|
|
4540
4540
|
},
|
|
4541
|
-
"description": "Create a new widget record. Writes live data.\n\n**Required:** `widget_name`.\n\n**Enums:** `widget_viewport`: `front`, `admin`, `both`; `bootstrap_enabled`: `0`, `1`.\n\n**See also:** `updateWidget` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4541
|
+
"description": "Create a new widget record. Writes live data.\n\n**Use when:** building a new reusable HTML block. Rare — usually configured via BD admin UI.\n\n**Required:** `widget_name`.\n\n**Enums:** `widget_viewport`: `front`, `admin`, `both`; `bootstrap_enabled`: `0`, `1`.\n\n**See also:** `updateWidget` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4542
4542
|
}
|
|
4543
4543
|
},
|
|
4544
4544
|
"/api/v2/data_widgets/update": {
|
|
@@ -4584,7 +4584,7 @@
|
|
|
4584
4584
|
}
|
|
4585
4585
|
}
|
|
4586
4586
|
},
|
|
4587
|
-
"description": "Update an existing widget record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `widget_id`.\n\n**See also:** `createWidget` (add new), `deleteWidget` (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._"
|
|
4587
|
+
"description": "Update an existing widget record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** editing widget HTML or settings.\n\n**Required:** `widget_id`.\n\n**See also:** `createWidget` (add new), `deleteWidget` (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._"
|
|
4588
4588
|
}
|
|
4589
4589
|
},
|
|
4590
4590
|
"/api/v2/data_widgets/delete": {
|
|
@@ -4624,14 +4624,14 @@
|
|
|
4624
4624
|
}
|
|
4625
4625
|
}
|
|
4626
4626
|
},
|
|
4627
|
-
"description": "Permanently delete a widget record by ID. Destructive — cannot be undone via API.\n\n**Required:** `widget_id`.\n\n**See also:** `updateWidget` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
4627
|
+
"description": "Permanently delete a widget record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing an unused widget. Any `[widget=Name]` shortcodes referencing it on pages/emails will render as empty or broken — audit first.\n\n**Required:** `widget_id`.\n\n**See also:** `updateWidget` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
4628
4628
|
}
|
|
4629
4629
|
},
|
|
4630
4630
|
"/api/v2/data_widgets/render": {
|
|
4631
4631
|
"post": {
|
|
4632
4632
|
"operationId": "renderWidget",
|
|
4633
4633
|
"summary": "Render a widget to HTML",
|
|
4634
|
-
"description": "Returns rendered HTML output with all template variables processed.\n\n**Required:** `widget_id`.\n\n**Parameter interactions:**\n- Returns rendered HTML for the named widget — side effect: may execute widget-specific PHP (database queries, cache lookups). Use carefully in loops\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
4634
|
+
"description": "Returns rendered HTML output with all template variables processed.\n\n**Use when:** fetching the RENDERED HTML output of a widget (with all shortcodes/tokens expanded) rather than its raw source. Useful for previewing in an external tool or scraping a widget's current state.\n\n**Required:** `widget_id`.\n\n**Parameter interactions:**\n- Returns rendered HTML for the named widget — side effect: may execute widget-specific PHP (database queries, cache lookups). Use carefully in loops\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
4635
4635
|
"tags": [
|
|
4636
4636
|
"Widgets"
|
|
4637
4637
|
],
|
|
@@ -4709,7 +4709,7 @@
|
|
|
4709
4709
|
}
|
|
4710
4710
|
}
|
|
4711
4711
|
},
|
|
4712
|
-
"description": "Paginated enumeration of emailtemplate records. Read-only.\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.\n\n**See also:** `getEmailTemplate` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4712
|
+
"description": "Paginated enumeration of emailtemplate records. Read-only.\n\n**Use when:** enumerating the site's transactional/marketing email templates before editing. Common audit: before bulk updating \"from\" addresses or footers.\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.\n\n**See also:** `getEmailTemplate` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4713
4713
|
}
|
|
4714
4714
|
},
|
|
4715
4715
|
"/api/v2/email_templates/get/{email_id}": {
|
|
@@ -4741,7 +4741,7 @@
|
|
|
4741
4741
|
}
|
|
4742
4742
|
}
|
|
4743
4743
|
},
|
|
4744
|
-
"description": "Fetch a single emailtemplate record. Read-only.\n\n**Required:** `email_id`.\n\n**See also:** `listEmailTemplates` (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._"
|
|
4744
|
+
"description": "Fetch a single emailtemplate record. Read-only.\n\n**Use when:** fetching one template's HTML body and subject for edit.\n\n**Required:** `email_id`.\n\n**See also:** `listEmailTemplates` (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._"
|
|
4745
4745
|
}
|
|
4746
4746
|
},
|
|
4747
4747
|
"/api/v2/email_templates/create": {
|
|
@@ -4834,7 +4834,7 @@
|
|
|
4834
4834
|
}
|
|
4835
4835
|
}
|
|
4836
4836
|
},
|
|
4837
|
-
"description": "Create a new emailtemplate record. Writes live data.\n\n**Required:** `email_name`.\n\n**Enums:** `signature`: `0`, `1`; `notemplate`: `0`, `1`; `unsubscribe_link`: `0`, `1`.\n\n**Parameter interactions:**\n- `email_subject` and `email_body` can use template tokens (e.g. `%%%website_name%%%`, recipient field tokens)\n- `email_body` supports HTML\n\n**See also:** `updateEmailTemplate` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4837
|
+
"description": "Create a new emailtemplate record. Writes live data.\n\n**Use when:** adding a new transactional/marketing template. Rare — most BD email templates are built into the admin UI.\n\n**Required:** `email_name`.\n\n**Enums:** `signature`: `0`, `1`; `notemplate`: `0`, `1`; `unsubscribe_link`: `0`, `1`.\n\n**Parameter interactions:**\n- `email_subject` and `email_body` can use template tokens (e.g. `%%%website_name%%%`, recipient field tokens)\n- `email_body` supports HTML\n\n**See also:** `updateEmailTemplate` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
4838
4838
|
}
|
|
4839
4839
|
},
|
|
4840
4840
|
"/api/v2/email_templates/update": {
|
|
@@ -4892,7 +4892,7 @@
|
|
|
4892
4892
|
}
|
|
4893
4893
|
}
|
|
4894
4894
|
},
|
|
4895
|
-
"description": "Update an existing emailtemplate record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `email_id`.\n\n**See also:** `createEmailTemplate` (add new), `deleteEmailTemplate` (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._"
|
|
4895
|
+
"description": "Update an existing emailtemplate record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** editing an email's subject or HTML body. Body supports template tokens (`%%%website_name%%%`, member field tokens) — preserve them during edits.\n\n**Required:** `email_id`.\n\n**See also:** `createEmailTemplate` (add new), `deleteEmailTemplate` (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._"
|
|
4896
4896
|
}
|
|
4897
4897
|
},
|
|
4898
4898
|
"/api/v2/email_templates/delete": {
|
|
@@ -4932,7 +4932,7 @@
|
|
|
4932
4932
|
}
|
|
4933
4933
|
}
|
|
4934
4934
|
},
|
|
4935
|
-
"description": "Permanently delete a emailtemplate record by ID. Destructive — cannot be undone via API.\n\n**Required:** `email_id`.\n\n**See also:** `updateEmailTemplate` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
4935
|
+
"description": "Permanently delete a emailtemplate record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a deprecated template. BD may fall back to defaults if a required system template is deleted — confirm before purging.\n\n**Required:** `email_id`.\n\n**See also:** `updateEmailTemplate` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
4936
4936
|
}
|
|
4937
4937
|
},
|
|
4938
4938
|
"/api/v2/form/get": {
|
|
@@ -4962,7 +4962,7 @@
|
|
|
4962
4962
|
}
|
|
4963
4963
|
}
|
|
4964
4964
|
},
|
|
4965
|
-
"description": "Paginated enumeration of form records. Read-only.\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.\n\n**See also:** `getForm` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4965
|
+
"description": "Paginated enumeration of form records. Read-only.\n\n**Use when:** enumerating the site's forms (signup, contact, quote request, custom forms). Child fields are fetched separately via `listFormFields`.\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.\n\n**See also:** `getForm` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
4966
4966
|
}
|
|
4967
4967
|
},
|
|
4968
4968
|
"/api/v2/form/get/{form_id}": {
|
|
@@ -4994,7 +4994,7 @@
|
|
|
4994
4994
|
}
|
|
4995
4995
|
}
|
|
4996
4996
|
},
|
|
4997
|
-
"description": "Fetch a single form record. Read-only.\n\n**Required:** `form_id`.\n\n**See also:** `listForms` (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._"
|
|
4997
|
+
"description": "Fetch a single form record. Read-only.\n\n**Use when:** fetching one form's metadata.\n\n**Required:** `form_id`.\n\n**See also:** `listForms` (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._"
|
|
4998
4998
|
}
|
|
4999
4999
|
},
|
|
5000
5000
|
"/api/v2/form/create": {
|
|
@@ -5067,7 +5067,7 @@
|
|
|
5067
5067
|
}
|
|
5068
5068
|
}
|
|
5069
5069
|
},
|
|
5070
|
-
"description": "Create a new form record. Writes live data.\n\n**Required:** `form_name`, `form_title`, `form_action`, `form_layout`, `form_table`.\n\n**Enums:** `form_email_on`: `0`, `1`.\n\n**Parameter interactions:**\n- After creating the form, add fields via `createFormField` using the returned form identifier\n\n**See also:** `updateForm` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5070
|
+
"description": "Create a new form record. Writes live data.\n\n**Use when:** adding a new form container. Add fields afterward with `createFormField`.\n\n**Required:** `form_name`, `form_title`, `form_action`, `form_layout`, `form_table`.\n\n**Enums:** `form_email_on`: `0`, `1`.\n\n**Parameter interactions:**\n- After creating the form, add fields via `createFormField` using the returned form identifier\n\n**See also:** `updateForm` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5071
5071
|
}
|
|
5072
5072
|
},
|
|
5073
5073
|
"/api/v2/form/update": {
|
|
@@ -5113,7 +5113,7 @@
|
|
|
5113
5113
|
}
|
|
5114
5114
|
}
|
|
5115
5115
|
},
|
|
5116
|
-
"description": "Update an existing form record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `form_id`.\n\n**See also:** `createForm` (add new), `deleteForm` (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._"
|
|
5116
|
+
"description": "Update an existing form record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming or re-configuring a form's wrapper.\n\n**Required:** `form_id`.\n\n**See also:** `createForm` (add new), `deleteForm` (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._"
|
|
5117
5117
|
}
|
|
5118
5118
|
},
|
|
5119
5119
|
"/api/v2/form/delete": {
|
|
@@ -5153,7 +5153,7 @@
|
|
|
5153
5153
|
}
|
|
5154
5154
|
}
|
|
5155
5155
|
},
|
|
5156
|
-
"description": "Permanently delete a form record by ID. Destructive — cannot be undone via API.\n\n**Required:** `form_id`.\n\n**See also:** `updateForm` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5156
|
+
"description": "Permanently delete a form record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a form — child fields orphan.\n\n**Required:** `form_id`.\n\n**See also:** `updateForm` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5157
5157
|
}
|
|
5158
5158
|
},
|
|
5159
5159
|
"/api/v2/form_fields/get": {
|
|
@@ -5183,7 +5183,7 @@
|
|
|
5183
5183
|
}
|
|
5184
5184
|
}
|
|
5185
5185
|
},
|
|
5186
|
-
"description": "Paginated enumeration of formfield records. Read-only.\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.\n\n**See also:** `getFormField` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5186
|
+
"description": "Paginated enumeration of formfield records. Read-only.\n\n**Use when:** listing fields on a form. Filter by `form_id` or `form_name`.\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.\n\n**See also:** `getFormField` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5187
5187
|
}
|
|
5188
5188
|
},
|
|
5189
5189
|
"/api/v2/form_fields/get/{field_id}": {
|
|
@@ -5215,7 +5215,7 @@
|
|
|
5215
5215
|
}
|
|
5216
5216
|
}
|
|
5217
5217
|
},
|
|
5218
|
-
"description": "Fetch a single formfield record. Read-only.\n\n**Required:** `field_id`.\n\n**See also:** `listFormFields` (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._"
|
|
5218
|
+
"description": "Fetch a single formfield record. Read-only.\n\n**Use when:** one field by ID.\n\n**Required:** `field_id`.\n\n**See also:** `listFormFields` (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._"
|
|
5219
5219
|
}
|
|
5220
5220
|
},
|
|
5221
5221
|
"/api/v2/form_fields/create": {
|
|
@@ -5330,7 +5330,7 @@
|
|
|
5330
5330
|
}
|
|
5331
5331
|
}
|
|
5332
5332
|
},
|
|
5333
|
-
"description": "Create a new formfield record. Writes live data.\n\n**Required:** `form_name`, `field_name`, `field_text`, `field_type`, `field_order`.\n\n**Enums:** `field_required`: `0`, `1`.\n\n**Parameter interactions:**\n- `form_id` / `form_name` — the parent form (from `createForm` or `listForms`)\n- Field type and options depend on the form type; validate against the form's field schema\n\n**See also:** `updateFormField` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5333
|
+
"description": "Create a new formfield record. Writes live data.\n\n**Use when:** adding an input to an existing form.\n\n**Required:** `form_name`, `field_name`, `field_text`, `field_type`, `field_order`.\n\n**Enums:** `field_required`: `0`, `1`.\n\n**Parameter interactions:**\n- `form_id` / `form_name` — the parent form (from `createForm` or `listForms`)\n- Field type and options depend on the form type; validate against the form's field schema\n\n**See also:** `updateFormField` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5334
5334
|
}
|
|
5335
5335
|
},
|
|
5336
5336
|
"/api/v2/form_fields/update": {
|
|
@@ -5416,7 +5416,7 @@
|
|
|
5416
5416
|
}
|
|
5417
5417
|
}
|
|
5418
5418
|
},
|
|
5419
|
-
"description": "Update an existing formfield record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `field_id`.\n\n**See also:** `createFormField` (add new), `deleteFormField` (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._"
|
|
5419
|
+
"description": "Update an existing formfield record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming, changing field type, or reordering.\n\n**Required:** `field_id`.\n\n**See also:** `createFormField` (add new), `deleteFormField` (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._"
|
|
5420
5420
|
}
|
|
5421
5421
|
},
|
|
5422
5422
|
"/api/v2/form_fields/delete": {
|
|
@@ -5456,7 +5456,7 @@
|
|
|
5456
5456
|
}
|
|
5457
5457
|
}
|
|
5458
5458
|
},
|
|
5459
|
-
"description": "Permanently delete a formfield record by ID. Destructive — cannot be undone via API.\n\n**Required:** `field_id`.\n\n**See also:** `updateFormField` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5459
|
+
"description": "Permanently delete a formfield record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a field. Existing submission records may reference the old field name — data persists but becomes orphan metadata.\n\n**Required:** `field_id`.\n\n**See also:** `updateFormField` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5460
5460
|
}
|
|
5461
5461
|
},
|
|
5462
5462
|
"/api/v2/subscription_types/get": {
|
|
@@ -5486,7 +5486,7 @@
|
|
|
5486
5486
|
}
|
|
5487
5487
|
}
|
|
5488
5488
|
},
|
|
5489
|
-
"description": "Paginated enumeration of membershipplan records. Read-only.\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.\n\n**See also:** `getMembershipPlan` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5489
|
+
"description": "Paginated enumeration of membershipplan records. Read-only.\n\n**Use when:** discovering `subscription_id` values to use when creating members. Essential prerequisite for `createUser` — every member needs a valid `subscription_id`.\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.\n\n**See also:** `getMembershipPlan` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5490
5490
|
}
|
|
5491
5491
|
},
|
|
5492
5492
|
"/api/v2/subscription_types/get/{subscription_id}": {
|
|
@@ -5518,7 +5518,7 @@
|
|
|
5518
5518
|
}
|
|
5519
5519
|
}
|
|
5520
5520
|
},
|
|
5521
|
-
"description": "Fetch a single membershipplan record. Read-only.\n\n**Required:** `subscription_id`.\n\n**See also:** `listMembershipPlans` (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._"
|
|
5521
|
+
"description": "Fetch a single membershipplan record. Read-only.\n\n**Use when:** fetching one plan's full config (pricing, features). Most sites have 2-10 plans; listing is usually cheap enough.\n\n**Required:** `subscription_id`.\n\n**See also:** `listMembershipPlans` (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._"
|
|
5522
5522
|
}
|
|
5523
5523
|
},
|
|
5524
5524
|
"/api/v2/subscription_types/create": {
|
|
@@ -5605,7 +5605,7 @@
|
|
|
5605
5605
|
}
|
|
5606
5606
|
}
|
|
5607
5607
|
},
|
|
5608
|
-
"description": "Create a new membershipplan record. Writes live data.\n\n**Required:** `subscription_name`, `subscription_type`, `profile_type`.\n\n**Enums:** `payment_default`: `yearly`, `monthly`.\n\n**Parameter interactions:**\n- `subscription_type` — typically `member` for standard member plans\n- `profile_type`: `paid`, `free`, or `claim` — controls how profile visibility and billing work\n- `monthly_amount` / `yearly_amount` — price in the site's currency\n- `sub_active=1` makes the plan available for new signups; `sub_active=0` grandfathers existing members only\n- `searchable=1` makes members on this plan findable in public search\n\n**See also:** `updateMembershipPlan` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5608
|
+
"description": "Create a new membershipplan record. Writes live data.\n\n**Use when:** launching a new plan tier. Rare — usually configured in BD admin UI. Check `profile_type` carefully: `paid`, `free`, or `claim` — changing later affects billing and visibility.\n\n**Required:** `subscription_name`, `subscription_type`, `profile_type`.\n\n**Enums:** `payment_default`: `yearly`, `monthly`.\n\n**Parameter interactions:**\n- `subscription_type` — typically `member` for standard member plans\n- `profile_type`: `paid`, `free`, or `claim` — controls how profile visibility and billing work\n- `monthly_amount` / `yearly_amount` — price in the site's currency\n- `sub_active=1` makes the plan available for new signups; `sub_active=0` grandfathers existing members only\n- `searchable=1` makes members on this plan findable in public search\n\n**See also:** `updateMembershipPlan` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5609
5609
|
}
|
|
5610
5610
|
},
|
|
5611
5611
|
"/api/v2/subscription_types/update": {
|
|
@@ -5660,7 +5660,7 @@
|
|
|
5660
5660
|
}
|
|
5661
5661
|
}
|
|
5662
5662
|
},
|
|
5663
|
-
"description": "Update an existing membershipplan record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `subscription_id`.\n\n**See also:** `createMembershipPlan` (add new), `deleteMembershipPlan` (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._"
|
|
5663
|
+
"description": "Update an existing membershipplan record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** adjusting pricing (`monthly_amount`/`yearly_amount`), toggling `sub_active` (new-signup availability), or changing feature flags like `searchable`, `photo_limit`. Changes apply to NEW signups; existing members on this plan keep their original terms unless manually migrated.\n\n**Required:** `subscription_id`.\n\n**See also:** `createMembershipPlan` (add new), `deleteMembershipPlan` (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._"
|
|
5664
5664
|
}
|
|
5665
5665
|
},
|
|
5666
5666
|
"/api/v2/subscription_types/delete": {
|
|
@@ -5700,7 +5700,7 @@
|
|
|
5700
5700
|
}
|
|
5701
5701
|
}
|
|
5702
5702
|
},
|
|
5703
|
-
"description": "Permanently delete a membershipplan record by ID. Destructive — cannot be undone via API.\n\n**Required:** `subscription_id`.\n\n**See also:** `updateMembershipPlan` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5703
|
+
"description": "Permanently delete a membershipplan record by ID. Destructive — cannot be undone via API.\n\n**Use when:** retiring a plan that has no members (or all its members have been migrated). Members with matching `subscription_id` become orphaned — migrate them first via `updateUser`.\n\n**Required:** `subscription_id`.\n\n**See also:** `updateMembershipPlan` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5704
5704
|
}
|
|
5705
5705
|
},
|
|
5706
5706
|
"/api/v2/menus/get": {
|
|
@@ -5730,7 +5730,7 @@
|
|
|
5730
5730
|
}
|
|
5731
5731
|
}
|
|
5732
5732
|
},
|
|
5733
|
-
"description": "Paginated enumeration of menu records. Read-only.\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.\n\n**See also:** `getMenu` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5733
|
+
"description": "Paginated enumeration of menu records. Read-only.\n\n**Use when:** enumerating navigation menus on the site (main menu, footer menu, sidebar, etc.). For items within a menu use `listMenuItems` with `menu_id` filter.\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.\n\n**See also:** `getMenu` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5734
5734
|
}
|
|
5735
5735
|
},
|
|
5736
5736
|
"/api/v2/menus/get/{menu_id}": {
|
|
@@ -5762,7 +5762,7 @@
|
|
|
5762
5762
|
}
|
|
5763
5763
|
}
|
|
5764
5764
|
},
|
|
5765
|
-
"description": "Fetch a single menu record. Read-only.\n\n**Required:** `menu_id`.\n\n**See also:** `listMenus` (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._"
|
|
5765
|
+
"description": "Fetch a single menu record. Read-only.\n\n**Use when:** fetching one menu's metadata. Child items are fetched separately.\n\n**Required:** `menu_id`.\n\n**See also:** `listMenus` (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._"
|
|
5766
5766
|
}
|
|
5767
5767
|
},
|
|
5768
5768
|
"/api/v2/menus/create": {
|
|
@@ -5835,7 +5835,7 @@
|
|
|
5835
5835
|
}
|
|
5836
5836
|
}
|
|
5837
5837
|
},
|
|
5838
|
-
"description": "Create a new menu record. Writes live data.\n\n**Required:** `menu_name`, `menu_title`.\n\n**Parameter interactions:**\n- `menu_name` (max 35 chars) — the internal identifier\n- `menu_title` — the visible heading\n- `menu_active`: `0`=Inactive, `1`=Active\n- After creating the container, add entries via `createMenuItem` using the returned `menu_id`\n\n**See also:** `updateMenu` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5838
|
+
"description": "Create a new menu record. Writes live data.\n\n**Use when:** adding a new navigation container. After creating the container, add entries via `createMenuItem` using the returned `menu_id`.\n\n**Required:** `menu_name`, `menu_title`.\n\n**Parameter interactions:**\n- `menu_name` (max 35 chars) — the internal identifier\n- `menu_title` — the visible heading\n- `menu_active`: `0`=Inactive, `1`=Active\n- After creating the container, add entries via `createMenuItem` using the returned `menu_id`\n\n**See also:** `updateMenu` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
5839
5839
|
}
|
|
5840
5840
|
},
|
|
5841
5841
|
"/api/v2/menus/update": {
|
|
@@ -5884,7 +5884,7 @@
|
|
|
5884
5884
|
}
|
|
5885
5885
|
}
|
|
5886
5886
|
},
|
|
5887
|
-
"description": "Update an existing menu record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `menu_id`.\n\n**See also:** `createMenu` (add new), `deleteMenu` (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._"
|
|
5887
|
+
"description": "Update an existing menu record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming a menu, toggling `menu_active`, or adjusting its CSS/HTML wrapper attributes.\n\n**Required:** `menu_id`.\n\n**See also:** `createMenu` (add new), `deleteMenu` (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._"
|
|
5888
5888
|
}
|
|
5889
5889
|
},
|
|
5890
5890
|
"/api/v2/menus/delete": {
|
|
@@ -5924,7 +5924,7 @@
|
|
|
5924
5924
|
}
|
|
5925
5925
|
}
|
|
5926
5926
|
},
|
|
5927
|
-
"description": "Permanently delete a menu record by ID. Destructive — cannot be undone via API.\n\n**Required:** `menu_id`.\n\n**See also:** `updateMenu` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5927
|
+
"description": "Permanently delete a menu record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a menu container. Child items (`menu_items` rows with matching `menu_id`) become orphaned — delete them first.\n\n**Required:** `menu_id`.\n\n**See also:** `updateMenu` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
5928
5928
|
}
|
|
5929
5929
|
},
|
|
5930
5930
|
"/api/v2/menu_items/get": {
|
|
@@ -5954,7 +5954,7 @@
|
|
|
5954
5954
|
}
|
|
5955
5955
|
}
|
|
5956
5956
|
},
|
|
5957
|
-
"description": "Paginated enumeration of menuitem records. Read-only.\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.\n\n**See also:** `getMenuItem` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5957
|
+
"description": "Paginated enumeration of menuitem records. Read-only.\n\n**Use when:** enumerating items in a menu — always filter by `menu_id`. Use `master_id` filter for sub-menu items.\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.\n\n**See also:** `getMenuItem` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
5958
5958
|
}
|
|
5959
5959
|
},
|
|
5960
5960
|
"/api/v2/menu_items/get/{menu_item_id}": {
|
|
@@ -5986,7 +5986,7 @@
|
|
|
5986
5986
|
}
|
|
5987
5987
|
}
|
|
5988
5988
|
},
|
|
5989
|
-
"description": "Fetch a single menuitem record. Read-only.\n\n**Required:** `menu_item_id`.\n\n**See also:** `listMenuItems` (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._"
|
|
5989
|
+
"description": "Fetch a single menuitem record. Read-only.\n\n**Use when:** editing one specific menu entry.\n\n**Required:** `menu_item_id`.\n\n**See also:** `listMenuItems` (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._"
|
|
5990
5990
|
}
|
|
5991
5991
|
},
|
|
5992
5992
|
"/api/v2/menu_items/create": {
|
|
@@ -6066,7 +6066,7 @@
|
|
|
6066
6066
|
}
|
|
6067
6067
|
}
|
|
6068
6068
|
},
|
|
6069
|
-
"description": "Create a new menuitem record. Writes live data.\n\n**Required:** `menu_id`, `menu_name`, `menu_link`, `master_id`, `menu_order`.\n\n**Enums:** `menu_active`: `0`=Inactive, `1`=Active.\n\n**Parameter interactions:**\n- `menu_id` — parent menu container (from `createMenu` or `listMenus`)\n- `master_id` — `0` for top-level items; for nested items, the ID of the parent menu item\n- `menu_order` — display position within the parent menu (integer, lower = earlier)\n- `menu_target`: `_blank` (new tab) or `_self` (same window)\n\n**See also:** `updateMenuItem` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
6069
|
+
"description": "Create a new menuitem record. Writes live data.\n\n**Use when:** adding a nav link to an existing menu. Parent `menu_id` must exist. For nested items pass `master_id=<parent menu_item_id>`; for top-level pass `0`. `menu_order` determines display position (lower = earlier).\n\n**Required:** `menu_id`, `menu_name`, `menu_link`, `master_id`, `menu_order`.\n\n**Enums:** `menu_active`: `0`=Inactive, `1`=Active.\n\n**Parameter interactions:**\n- `menu_id` — parent menu container (from `createMenu` or `listMenus`)\n- `master_id` — `0` for top-level items; for nested items, the ID of the parent menu item\n- `menu_order` — display position within the parent menu (integer, lower = earlier)\n- `menu_target`: `_blank` (new tab) or `_self` (same window)\n\n**See also:** `updateMenuItem` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
6070
6070
|
}
|
|
6071
6071
|
},
|
|
6072
6072
|
"/api/v2/menu_items/update": {
|
|
@@ -6118,7 +6118,7 @@
|
|
|
6118
6118
|
}
|
|
6119
6119
|
}
|
|
6120
6120
|
},
|
|
6121
|
-
"description": "Update an existing menuitem record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `menu_item_id`.\n\n**See also:** `createMenuItem` (add new), `deleteMenuItem` (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._"
|
|
6121
|
+
"description": "Update an existing menuitem record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming, re-linking (change `menu_link`), reordering (change `menu_order`), or hiding (change `menu_active=0`).\n\n**Required:** `menu_item_id`.\n\n**See also:** `createMenuItem` (add new), `deleteMenuItem` (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._"
|
|
6122
6122
|
}
|
|
6123
6123
|
},
|
|
6124
6124
|
"/api/v2/menu_items/delete": {
|
|
@@ -6158,7 +6158,7 @@
|
|
|
6158
6158
|
}
|
|
6159
6159
|
}
|
|
6160
6160
|
},
|
|
6161
|
-
"description": "Permanently delete a menuitem record by ID. Destructive — cannot be undone via API.\n\n**Required:** `menu_item_id`.\n\n**See also:** `updateMenuItem` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
6161
|
+
"description": "Permanently delete a menuitem record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a single menu entry.\n\n**Required:** `menu_item_id`.\n\n**See also:** `updateMenuItem` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
6162
6162
|
}
|
|
6163
6163
|
},
|
|
6164
6164
|
"/api/v2/list_services/get": {
|
|
@@ -6188,7 +6188,7 @@
|
|
|
6188
6188
|
}
|
|
6189
6189
|
}
|
|
6190
6190
|
},
|
|
6191
|
-
"description": "Paginated enumeration of SUB-level member categories (services). Read-only.\n\nSub Categories are level 2 of the 3-tier member classification (e.g., \"Sushi\" under \"Restaurants\"). Each has a `profession_id` pointing at its parent Top Category. `master_id` points at a parent Sub Category for sub-sub-category nesting (`master_id=0` = directly under a Top Category). Backed by BD's `list_services` table.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` token.\n\n**Filter/sort:** filter by `profession_id` to scope to sub-categories under one top category. Standard `property`/`property_value`/`property_operator` for other fields.\n\n**See also:** `getSubCategory` (single by ID), `listTopCategories` (parents), `createSubCategory` (add new).\n\n**Returns:** `{ status: \"success\", total, ..., message: [...records] }`. Each record has `service_id`, `name`, `desc`, `profession_id`, `master_id`, `filename`, `keywords`, `sort_order`, `lead_price`, `image`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6191
|
+
"description": "Paginated enumeration of SUB-level member categories (services). Read-only.\n\nSub Categories are level 2 of the 3-tier member classification (e.g., \"Sushi\" under \"Restaurants\"). Each has a `profession_id` pointing at its parent Top Category. `master_id` points at a parent Sub Category for sub-sub-category nesting (`master_id=0` = directly under a Top Category). Backed by BD's `list_services` table.\n\n**Use when:** enumerating sub-categories (services) — always filter by `profession_id` to scope to one Top Category, otherwise you get all sub-cats across all tops (noisy). For sub-sub nesting, `master_id` filter narrows further.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` token.\n\n**Filter/sort:** filter by `profession_id` to scope to sub-categories under one top category. Standard `property`/`property_value`/`property_operator` for other fields.\n\n**See also:** `getSubCategory` (single by ID), `listTopCategories` (parents), `createSubCategory` (add new).\n\n**Returns:** `{ status: \"success\", total, ..., message: [...records] }`. Each record has `service_id`, `name`, `desc`, `profession_id`, `master_id`, `filename`, `keywords`, `sort_order`, `lead_price`, `image`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6192
6192
|
}
|
|
6193
6193
|
},
|
|
6194
6194
|
"/api/v2/list_services/get/{service_id}": {
|
|
@@ -6220,7 +6220,7 @@
|
|
|
6220
6220
|
}
|
|
6221
6221
|
}
|
|
6222
6222
|
},
|
|
6223
|
-
"description": "Fetch a single SUB-level member category (service) by `service_id`. Read-only.\n\n**Required:** `service_id` (path).\n\n**See also:** `listSubCategories` (enumerate; filter by `profession_id` for scope), `getTopCategory` (fetch parent Top by `profession_id`).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6223
|
+
"description": "Fetch a single SUB-level member category (service) by `service_id`. Read-only.\n\n**Use when:** fetching one sub-category by `service_id` — usually after discovering it via `listSubCategories`.\n\n**Required:** `service_id` (path).\n\n**See also:** `listSubCategories` (enumerate; filter by `profession_id` for scope), `getTopCategory` (fetch parent Top by `profession_id`).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6224
6224
|
}
|
|
6225
6225
|
},
|
|
6226
6226
|
"/api/v2/list_services/create": {
|
|
@@ -6283,7 +6283,7 @@
|
|
|
6283
6283
|
}
|
|
6284
6284
|
}
|
|
6285
6285
|
},
|
|
6286
|
-
"description": "Create a new SUB-level member category under an existing Top Category. Writes live data.\n\nA Sub Category is level 2 of the 3-tier member classification. It MUST have a parent Top Category (via `profession_id`). It may optionally sit under another Sub Category (for sub-sub-category nesting, via `master_id`). Backed by BD's `list_services` table.\n\n**Required:** `name`, `profession_id`.\n\n**Parameter guidance:**\n- `name` — human-readable (e.g. \"Sushi\")\n- `profession_id` — the parent Top Category's ID (from `listTopCategories` or `createTopCategory`)\n- `master_id` — for SUB-SUB-CATEGORY nesting, pass the parent Sub Category's ID; default 0 means \"directly under the Top Category\"\n- `filename` — URL-slug form; `desc`, `keywords`, `sort_order`, `lead_price`, `image` — all optional\n\n**See also:** `updateSubCategory` (modify), `listSubCategories` (list), `createTopCategory` (create parent).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` including `service_id`. Use that to assign members via `updateUser.services` (CSV) or `createMemberSubCategoryLink`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6286
|
+
"description": "Create a new SUB-level member category under an existing Top Category. Writes live data.\n\nA Sub Category is level 2 of the 3-tier member classification. It MUST have a parent Top Category (via `profession_id`). It may optionally sit under another Sub Category (for sub-sub-category nesting, via `master_id`). Backed by BD's `list_services` table.\n\n**Use when:** explicitly adding a sub-category BEFORE assigning members to it. If creating/updating a user who needs a sub-category that doesn't exist yet, on `createUser` just include the name in `services` — BD auto-creates it. On `updateUser`, pass `create_new_categories=1` to allow inline creation. For sub-sub nesting pass `master_id=<parent service_id>`; otherwise set `master_id=0` for direct-under-Top.\n\n**Required:** `name`, `profession_id`.\n\n**Parameter guidance:**\n- `name` — human-readable (e.g. \"Sushi\")\n- `profession_id` — the parent Top Category's ID (from `listTopCategories` or `createTopCategory`)\n- `master_id` — for SUB-SUB-CATEGORY nesting, pass the parent Sub Category's ID; default 0 means \"directly under the Top Category\"\n- `filename` — URL-slug form; `desc`, `keywords`, `sort_order`, `lead_price`, `image` — all optional\n\n**See also:** `updateSubCategory` (modify), `listSubCategories` (list), `createTopCategory` (create parent).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` including `service_id`. Use that to assign members via `updateUser.services` (CSV) or `createMemberSubCategoryLink`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6287
6287
|
}
|
|
6288
6288
|
},
|
|
6289
6289
|
"/api/v2/list_services/update": {
|
|
@@ -6347,7 +6347,7 @@
|
|
|
6347
6347
|
}
|
|
6348
6348
|
}
|
|
6349
6349
|
},
|
|
6350
|
-
"description": "Update an existing SUB-level member category by `service_id`. Fields omitted are untouched. Writes live data.\n\n**Required:** `service_id`.\n\n**Parameter notes:**\n- Change `profession_id` to move this Sub Category to a different parent Top Category\n- Change `master_id` to re-nest as a sub-sub-category (non-zero) or flatten to direct-under-Top (0)\n\n**See also:** `createSubCategory` (add new), `deleteSubCategory` (remove).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6350
|
+
"description": "Update an existing SUB-level member category by `service_id`. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming, re-parenting (change `profession_id` to move under a different Top, or `master_id` to re-nest as sub-sub), or adjusting `lead_price` for per-service lead pricing.\n\n**Required:** `service_id`.\n\n**Parameter notes:**\n- Change `profession_id` to move this Sub Category to a different parent Top Category\n- Change `master_id` to re-nest as a sub-sub-category (non-zero) or flatten to direct-under-Top (0)\n\n**See also:** `createSubCategory` (add new), `deleteSubCategory` (remove).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6351
6351
|
}
|
|
6352
6352
|
},
|
|
6353
6353
|
"/api/v2/list_services/delete": {
|
|
@@ -6387,7 +6387,7 @@
|
|
|
6387
6387
|
}
|
|
6388
6388
|
}
|
|
6389
6389
|
},
|
|
6390
|
-
"description": "Permanently delete a SUB-level member category by `service_id`. Destructive — cannot be undone via API.\n\n**Required:** `service_id`.\n\n**Destructive:** confirm intent. Members whose `users_data.services` CSV contains this ID will have an orphan reference. Any Member ↔ Sub Category links (`rel_services`) pointing at this service_id also become orphaned.\n\n**See also:** `updateSubCategory` (modify without removing).\n\n**Returns:** `{ status: \"success\", message: \"list_services record was deleted\" }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6390
|
+
"description": "Permanently delete a SUB-level member category by `service_id`. Destructive — cannot be undone via API.\n\n**Use when:** removing an unused sub-category. Any member with this `service_id` in their `users_data.services` CSV or in `rel_services` rows becomes orphaned — clean those up first.\n\n**Required:** `service_id`.\n\n**Destructive:** confirm intent. Members whose `users_data.services` CSV contains this ID will have an orphan reference. Any Member ↔ Sub Category links (`rel_services`) pointing at this service_id also become orphaned.\n\n**See also:** `updateSubCategory` (modify without removing).\n\n**Returns:** `{ status: \"success\", message: \"list_services record was deleted\" }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6391
6391
|
}
|
|
6392
6392
|
},
|
|
6393
6393
|
"/api/v2/rel_services/get": {
|
|
@@ -6417,7 +6417,7 @@
|
|
|
6417
6417
|
}
|
|
6418
6418
|
}
|
|
6419
6419
|
},
|
|
6420
|
-
"description": "Paginated enumeration of MEMBER ↔ SUB CATEGORY links. Read-only.\n\nEach record links a member (`user_id`) to a Sub Category (`service_id`) with per-link metadata: `avg_price`, `specialty`, `num_completed`, `date`. This is level 3 of the member-taxonomy relationship. Backed by BD's `rel_services` table.\n\n**When to use this vs. the simpler `users_data.services` CSV field:** use this resource when you need PER-LINK metadata (pricing tier, specialty flag, completion counter). If you just want \"this member is tagged with these Sub Categories\" with no extra data, set `updateUser.services` (CSV of service IDs) instead.\n\n**Pagination + filter/sort:** standard.\n\n**See also:** `getMemberSubCategoryLink`, `createMemberSubCategoryLink`, `listSubCategories` (available Sub Categories), `updateUser` (sets the `services` CSV for simpler cases).\n\n**Returns:** `{ status: \"success\", ..., message: [...records] }`. Each has `rel_id`, `user_id`, `service_id`, `date`, `avg_price`, `num_completed`, `specialty`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6420
|
+
"description": "Paginated enumeration of MEMBER ↔ SUB CATEGORY links. Read-only.\n\nEach record links a member (`user_id`) to a Sub Category (`service_id`) with per-link metadata: `avg_price`, `specialty`, `num_completed`, `date`. This is level 3 of the member-taxonomy relationship. Backed by BD's `rel_services` table.\n\n**Use when:** auditing per-service-link metadata (prices, specialty flags, completion counts) across members. Filter by `user_id` to see one member's links, `service_id` to see everyone offering that service. For simpler \"is this member tagged with this sub-cat\" checks, the `users_data.services` CSV on the member record is cheaper.\n\n**When to use this vs. the simpler `users_data.services` CSV field:** use this resource when you need PER-LINK metadata (pricing tier, specialty flag, completion counter). If you just want \"this member is tagged with these Sub Categories\" with no extra data, set `updateUser.services` (CSV of service IDs) instead.\n\n**Pagination + filter/sort:** standard.\n\n**See also:** `getMemberSubCategoryLink`, `createMemberSubCategoryLink`, `listSubCategories` (available Sub Categories), `updateUser` (sets the `services` CSV for simpler cases).\n\n**Returns:** `{ status: \"success\", ..., message: [...records] }`. Each has `rel_id`, `user_id`, `service_id`, `date`, `avg_price`, `num_completed`, `specialty`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6421
6421
|
}
|
|
6422
6422
|
},
|
|
6423
6423
|
"/api/v2/rel_services/get/{rel_id}": {
|
|
@@ -6449,7 +6449,7 @@
|
|
|
6449
6449
|
}
|
|
6450
6450
|
}
|
|
6451
6451
|
},
|
|
6452
|
-
"description": "Fetch a single Member ↔ Sub Category link by `rel_id`. Read-only.\n\n**Required:** `rel_id`.\n\n**See also:** `listMemberSubCategoryLinks` (enumerate, filter by `user_id` or `service_id`).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6452
|
+
"description": "Fetch a single Member ↔ Sub Category link by `rel_id`. Read-only.\n\n**Use when:** you have a `rel_id` and need the full link row. Rare — most workflows query by `user_id` or `service_id` via `listMemberSubCategoryLinks`.\n\n**Required:** `rel_id`.\n\n**See also:** `listMemberSubCategoryLinks` (enumerate, filter by `user_id` or `service_id`).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6453
6453
|
}
|
|
6454
6454
|
},
|
|
6455
6455
|
"/api/v2/rel_services/create": {
|
|
@@ -6507,7 +6507,7 @@
|
|
|
6507
6507
|
}
|
|
6508
6508
|
}
|
|
6509
6509
|
},
|
|
6510
|
-
"description": "Create a new Member ↔ Sub Category link with optional metadata. Writes live data.\n\nLinks an existing member (`user_id`) to an existing Sub Category (`service_id`) with per-link metadata (pricing, specialty). This is the richer alternative to setting `users_data.services` CSV via `updateUser` — use this when you need per-link data.\n\n**Required:** `user_id`, `service_id`.\n\n**Parameter guidance:**\n- `user_id` — member (from `listUsers` / `searchUsers`)\n- `service_id` — Sub Category (from `listSubCategories`)\n- `avg_price` — decimal, the member's price for this service\n- `specialty` — `0` or `1` flags this Sub Category as a specialty offering on the member's profile\n- `num_completed` — counter of jobs/projects completed in this Sub Category\n- `date` — YYYYMMDDHHmmss timestamp\n\n**See also:** `updateUser` with `services=\"<csv>\"` (simpler, no per-link metadata), `listSubCategories`, `getMemberSubCategoryLink`.\n\n**Writes live data:** appears on the member's public profile immediately.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` with `rel_id`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6510
|
+
"description": "Create a new Member ↔ Sub Category link with optional metadata. Writes live data.\n\nLinks an existing member (`user_id`) to an existing Sub Category (`service_id`) with per-link metadata (pricing, specialty). This is the richer alternative to setting `users_data.services` CSV via `updateUser` — use this when you need per-link data.\n\n**Use when:** the simpler `users_data.services` CSV isn't rich enough — you need per-link `avg_price`, `specialty=1`, or `num_completed`. For plain \"tag this member with this sub-cat\" use `updateUser` with `services=<service_id>` instead.\n\n**Required:** `user_id`, `service_id`.\n\n**Parameter guidance:**\n- `user_id` — member (from `listUsers` / `searchUsers`)\n- `service_id` — Sub Category (from `listSubCategories`)\n- `avg_price` — decimal, the member's price for this service\n- `specialty` — `0` or `1` flags this Sub Category as a specialty offering on the member's profile\n- `num_completed` — counter of jobs/projects completed in this Sub Category\n- `date` — YYYYMMDDHHmmss timestamp\n\n**See also:** `updateUser` with `services=\"<csv>\"` (simpler, no per-link metadata), `listSubCategories`, `getMemberSubCategoryLink`.\n\n**Writes live data:** appears on the member's public profile immediately.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` with `rel_id`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6511
6511
|
}
|
|
6512
6512
|
},
|
|
6513
6513
|
"/api/v2/rel_services/update": {
|
|
@@ -6559,7 +6559,7 @@
|
|
|
6559
6559
|
}
|
|
6560
6560
|
}
|
|
6561
6561
|
},
|
|
6562
|
-
"description": "Update a Member ↔ Sub Category link by `rel_id`. Fields omitted are untouched. Writes live data.\n\n**Required:** `rel_id`.\n\n**Updatable fields:** `avg_price`, `specialty`, `num_completed`, `date`.\n\n**See also:** `createMemberSubCategoryLink` (add new), `deleteMemberSubCategoryLink` (remove).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6562
|
+
"description": "Update a Member ↔ Sub Category link by `rel_id`. Fields omitted are untouched. Writes live data.\n\n**Use when:** adjusting per-link metadata — member's price for this service, specialty flag, completion counter.\n\n**Required:** `rel_id`.\n\n**Updatable fields:** `avg_price`, `specialty`, `num_completed`, `date`.\n\n**See also:** `createMemberSubCategoryLink` (add new), `deleteMemberSubCategoryLink` (remove).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6563
6563
|
}
|
|
6564
6564
|
},
|
|
6565
6565
|
"/api/v2/rel_services/delete": {
|
|
@@ -6599,7 +6599,7 @@
|
|
|
6599
6599
|
}
|
|
6600
6600
|
}
|
|
6601
6601
|
},
|
|
6602
|
-
"description": "Permanently delete a Member ↔ Sub Category link by `rel_id`. Destructive — cannot be undone via API.\n\nRemoves the member's link to this Sub Category in the `rel_services` join table. Does NOT remove the member from `users_data.services` CSV if the service_id is listed there — update that separately via `updateUser` if needed.\n\n**Required:** `rel_id`.\n\n**Returns:** `{ status: \"success\", message: \"rel_services record was deleted\" }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6602
|
+
"description": "Permanently delete a Member ↔ Sub Category link by `rel_id`. Destructive — cannot be undone via API.\n\nRemoves the member's link to this Sub Category in the `rel_services` join table. Does NOT remove the member from `users_data.services` CSV if the service_id is listed there — update that separately via `updateUser` if needed.\n\n**Use when:** removing a specific link row. Does NOT update the `users_data.services` CSV — that's a separate field; update it via `updateUser` if the service_id is also listed there.\n\n**Required:** `rel_id`.\n\n**Returns:** `{ status: \"success\", message: \"rel_services record was deleted\" }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
6603
6603
|
}
|
|
6604
6604
|
},
|
|
6605
6605
|
"/api/v2/users_photo/get": {
|
|
@@ -6629,7 +6629,7 @@
|
|
|
6629
6629
|
}
|
|
6630
6630
|
}
|
|
6631
6631
|
},
|
|
6632
|
-
"description": "Paginated enumeration of userphoto records. Read-only.\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.\n\n**See also:** `getUserPhoto` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
6632
|
+
"description": "Paginated enumeration of userphoto records. Read-only.\n\n**Use when:** enumerating photos attached to members (profile, logo, cover). Filter by `user_id`.\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.\n\n**See also:** `getUserPhoto` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
6633
6633
|
}
|
|
6634
6634
|
},
|
|
6635
6635
|
"/api/v2/users_photo/get/{photo_id}": {
|
|
@@ -6661,7 +6661,7 @@
|
|
|
6661
6661
|
}
|
|
6662
6662
|
}
|
|
6663
6663
|
},
|
|
6664
|
-
"description": "Fetch a single userphoto record. Read-only.\n\n**Required:** `photo_id`.\n\n**See also:** `listUserPhotos` (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._"
|
|
6664
|
+
"description": "Fetch a single userphoto record. Read-only.\n\n**Use when:** fetching one photo record by `photo_id`.\n\n**Required:** `photo_id`.\n\n**See also:** `listUserPhotos` (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._"
|
|
6665
6665
|
}
|
|
6666
6666
|
},
|
|
6667
6667
|
"/api/v2/users_photo/create": {
|
|
@@ -6719,7 +6719,7 @@
|
|
|
6719
6719
|
}
|
|
6720
6720
|
}
|
|
6721
6721
|
},
|
|
6722
|
-
"description": "Create a new userphoto record. Writes live data.\n\n**Required:** `user_id`, `file`, `type`.\n\n**Parameter interactions:**\n- `user_id` — the member\n- `type` — slot: `logo`, `photo`, or `cover_photo`\n- `file` — image filename (must already exist in site storage)\n\n**See also:** `updateUserPhoto` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
6722
|
+
"description": "Create a new userphoto record. Writes live data.\n\n**Use when:** attaching a new photo record to a member. The image file must already exist in site storage (upload via admin or `auto_image_import`).\n\n**Required:** `user_id`, `file`, `type`.\n\n**Parameter interactions:**\n- `user_id` — the member\n- `type` — slot: `logo`, `photo`, or `cover_photo`\n- `file` — image filename (must already exist in site storage)\n\n**See also:** `updateUserPhoto` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
6723
6723
|
}
|
|
6724
6724
|
},
|
|
6725
6725
|
"/api/v2/users_photo/update": {
|
|
@@ -6767,7 +6767,7 @@
|
|
|
6767
6767
|
}
|
|
6768
6768
|
}
|
|
6769
6769
|
},
|
|
6770
|
-
"description": "Update an existing userphoto record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `photo_id`.\n\n**Enums:** `type`: `logo`, `photo`, `cover_photo`.\n\n**See also:** `createUserPhoto` (add new), `deleteUserPhoto` (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._"
|
|
6770
|
+
"description": "Update an existing userphoto record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** changing a photo's `type` slot (logo/photo/cover_photo).\n\n**Required:** `photo_id`.\n\n**Enums:** `type`: `logo`, `photo`, `cover_photo`.\n\n**See also:** `createUserPhoto` (add new), `deleteUserPhoto` (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._"
|
|
6771
6771
|
}
|
|
6772
6772
|
},
|
|
6773
6773
|
"/api/v2/users_photo/delete": {
|
|
@@ -6807,7 +6807,7 @@
|
|
|
6807
6807
|
}
|
|
6808
6808
|
}
|
|
6809
6809
|
},
|
|
6810
|
-
"description": "Permanently delete a userphoto record by ID. Destructive — cannot be undone via API.\n\n**Required:** `photo_id`.\n\n**See also:** `updateUserPhoto` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
6810
|
+
"description": "Permanently delete a userphoto record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a photo attachment. For member image management consider `updateUser` with `images_action=remove_all` / `remove_cover_image` / etc. instead — that covers the member-record side of image cleanup.\n\n**Required:** `photo_id`.\n\n**See also:** `updateUserPhoto` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
6811
6811
|
}
|
|
6812
6812
|
},
|
|
6813
6813
|
"/api/v2/users_meta/get": {
|
|
@@ -6837,7 +6837,7 @@
|
|
|
6837
6837
|
}
|
|
6838
6838
|
}
|
|
6839
6839
|
},
|
|
6840
|
-
"description": "Paginated enumeration of usermeta records. Read-only.\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.\n\n**See also:** `getUserMeta` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
6840
|
+
"description": "Paginated enumeration of usermeta records. Read-only.\n\n**Use when:** enumerating metadata rows (key/value pairs). Filter by `database`+`database_id` to get metadata for one record.\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.\n\n**See also:** `getUserMeta` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
6841
6841
|
}
|
|
6842
6842
|
},
|
|
6843
6843
|
"/api/v2/users_meta/get/{meta_id}": {
|
|
@@ -6869,7 +6869,7 @@
|
|
|
6869
6869
|
}
|
|
6870
6870
|
}
|
|
6871
6871
|
},
|
|
6872
|
-
"description": "Fetch a single usermeta record. Read-only.\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._"
|
|
6872
|
+
"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._"
|
|
6873
6873
|
}
|
|
6874
6874
|
},
|
|
6875
6875
|
"/api/v2/users_meta/create": {
|
|
@@ -6927,7 +6927,7 @@
|
|
|
6927
6927
|
}
|
|
6928
6928
|
}
|
|
6929
6929
|
},
|
|
6930
|
-
"description": "Create a new usermeta record. Writes live data.\n\n**Required:** `database`, `database_id`, `key`, `value`.\n\n**Parameter interactions:**\n- `database` — the target table name (e.g. `users_data`, `data_posts`)\n- `database_id` — the record ID in that table to attach metadata to\n- `key` + `value` — the metadata entry itself (arbitrary key/value pair)\n\n**See also:** `updateUserMeta` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
6930
|
+
"description": "Create a new usermeta record. Writes live data.\n\n**Use when:** attaching a custom key/value to any record. `database` is the target table name (e.g., `users_data`), `database_id` is the record's PK.\n\n**Required:** `database`, `database_id`, `key`, `value`.\n\n**Parameter interactions:**\n- `database` — the target table name (e.g. `users_data`, `data_posts`)\n- `database_id` — the record ID in that table to attach metadata to\n- `key` + `value` — the metadata entry itself (arbitrary key/value pair)\n\n**See also:** `updateUserMeta` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
6931
6931
|
}
|
|
6932
6932
|
},
|
|
6933
6933
|
"/api/v2/users_meta/update": {
|
|
@@ -6971,7 +6971,7 @@
|
|
|
6971
6971
|
}
|
|
6972
6972
|
}
|
|
6973
6973
|
},
|
|
6974
|
-
"description": "Update an existing usermeta record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `meta_id`, `value`.\n\n**See also:** `createUserMeta` (add new), `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._"
|
|
6974
|
+
"description": "Update an existing usermeta record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** changing a metadata value.\n\n**Required:** `meta_id`, `value`.\n\n**See also:** `createUserMeta` (add new), `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._"
|
|
6975
6975
|
}
|
|
6976
6976
|
},
|
|
6977
6977
|
"/api/v2/users_meta/delete": {
|
|
@@ -7011,7 +7011,7 @@
|
|
|
7011
7011
|
}
|
|
7012
7012
|
}
|
|
7013
7013
|
},
|
|
7014
|
-
"description": "Permanently delete a usermeta record by ID. Destructive — cannot be undone via API.\n\n**Required:** `meta_id`.\n\n**See also:** `updateUserMeta` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7014
|
+
"description": "Permanently delete a usermeta record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a metadata row.\n\n**Required:** `meta_id`.\n\n**See also:** `updateUserMeta` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7015
7015
|
}
|
|
7016
7016
|
},
|
|
7017
7017
|
"/api/v2/tags/get": {
|
|
@@ -7041,7 +7041,7 @@
|
|
|
7041
7041
|
}
|
|
7042
7042
|
}
|
|
7043
7043
|
},
|
|
7044
|
-
"description": "Paginated enumeration of tag records. Read-only.\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.\n\n**See also:** `getTag` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7044
|
+
"description": "Paginated enumeration of tag records. Read-only.\n\n**Use when:** enumerating member tags, fetching tag names for display, or building a tag-management UI. Tags are lightweight labels attached to members, different from categories (which are taxonomy).\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.\n\n**See also:** `getTag` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7045
7045
|
}
|
|
7046
7046
|
},
|
|
7047
7047
|
"/api/v2/tags/get/{id}": {
|
|
@@ -7073,7 +7073,7 @@
|
|
|
7073
7073
|
}
|
|
7074
7074
|
}
|
|
7075
7075
|
},
|
|
7076
|
-
"description": "Fetch a single tag record. Read-only.\n\n**Required:** `id`.\n\n**See also:** `listTags` (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._"
|
|
7076
|
+
"description": "Fetch a single tag record. Read-only.\n\n**Use when:** fetching one tag by ID.\n\n**Required:** `id`.\n\n**See also:** `listTags` (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._"
|
|
7077
7077
|
}
|
|
7078
7078
|
},
|
|
7079
7079
|
"/api/v2/tags/create": {
|
|
@@ -7122,7 +7122,7 @@
|
|
|
7122
7122
|
}
|
|
7123
7123
|
}
|
|
7124
7124
|
},
|
|
7125
|
-
"description": "Create a new tag record. Writes live data.\n\n**Required:** `tag_name`, `group_tag_id`, `added_by`.\n\n**Parameter interactions:**\n- `tag_name` — the visible label\n- `group_tag_id` — tag group from `listTagGroups`\n- `added_by` — user ID of the admin creating the tag\n\n**See also:** `updateTag` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7125
|
+
"description": "Create a new tag record. Writes live data.\n\n**Use when:** adding a new tag. Group (`group_tag_id`) must exist — discover via `listTagGroups`.\n\n**Required:** `tag_name`, `group_tag_id`, `added_by`.\n\n**Parameter interactions:**\n- `tag_name` — the visible label\n- `group_tag_id` — tag group from `listTagGroups`\n- `added_by` — user ID of the admin creating the tag\n\n**See also:** `updateTag` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7126
7126
|
}
|
|
7127
7127
|
},
|
|
7128
7128
|
"/api/v2/tags/update": {
|
|
@@ -7165,7 +7165,7 @@
|
|
|
7165
7165
|
}
|
|
7166
7166
|
}
|
|
7167
7167
|
},
|
|
7168
|
-
"description": "Update an existing tag record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `id`.\n\n**See also:** `createTag` (add new), `deleteTag` (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._"
|
|
7168
|
+
"description": "Update an existing tag record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming a tag without losing the tag-to-member relationships.\n\n**Required:** `id`.\n\n**See also:** `createTag` (add new), `deleteTag` (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._"
|
|
7169
7169
|
}
|
|
7170
7170
|
},
|
|
7171
7171
|
"/api/v2/tags/delete": {
|
|
@@ -7205,7 +7205,7 @@
|
|
|
7205
7205
|
}
|
|
7206
7206
|
}
|
|
7207
7207
|
},
|
|
7208
|
-
"description": "Permanently delete a tag record by ID. Destructive — cannot be undone via API.\n\n**Required:** `id`.\n\n**See also:** `updateTag` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7208
|
+
"description": "Permanently delete a tag record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a tag entirely. Tag-relationships (`rel_tags`) pointing at it may orphan.\n\n**Required:** `id`.\n\n**See also:** `updateTag` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7209
7209
|
}
|
|
7210
7210
|
},
|
|
7211
7211
|
"/api/v2/tag_groups/get": {
|
|
@@ -7235,7 +7235,7 @@
|
|
|
7235
7235
|
}
|
|
7236
7236
|
}
|
|
7237
7237
|
},
|
|
7238
|
-
"description": "Paginated enumeration of taggroup records. Read-only.\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.\n\n**See also:** `getTagGroup` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7238
|
+
"description": "Paginated enumeration of taggroup records. Read-only.\n\n**Use when:** discovering the tag groupings before creating tags — each tag belongs to a group.\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.\n\n**See also:** `getTagGroup` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7239
7239
|
}
|
|
7240
7240
|
},
|
|
7241
7241
|
"/api/v2/tag_groups/get/{id}": {
|
|
@@ -7267,7 +7267,7 @@
|
|
|
7267
7267
|
}
|
|
7268
7268
|
}
|
|
7269
7269
|
},
|
|
7270
|
-
"description": "Fetch a single taggroup record. Read-only.\n\n**Required:** `id`.\n\n**See also:** `listTagGroups` (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._"
|
|
7270
|
+
"description": "Fetch a single taggroup record. Read-only.\n\n**Use when:** fetching one tag group by ID.\n\n**Required:** `id`.\n\n**See also:** `listTagGroups` (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._"
|
|
7271
7271
|
}
|
|
7272
7272
|
},
|
|
7273
7273
|
"/api/v2/tag_groups/create": {
|
|
@@ -7315,7 +7315,7 @@
|
|
|
7315
7315
|
}
|
|
7316
7316
|
}
|
|
7317
7317
|
},
|
|
7318
|
-
"description": "Create a new taggroup record. Writes live data.\n\n**Required:** `group_tag_name`, `added_by`, `updated_by`.\n\n**See also:** `updateTagGroup` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7318
|
+
"description": "Create a new taggroup record. Writes live data.\n\n**Use when:** organizing tags into new themes (e.g., \"Skill Level\", \"Service Area\"). Rare.\n\n**Required:** `group_tag_name`, `added_by`, `updated_by`.\n\n**See also:** `updateTagGroup` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7319
7319
|
}
|
|
7320
7320
|
},
|
|
7321
7321
|
"/api/v2/tag_groups/update": {
|
|
@@ -7358,7 +7358,7 @@
|
|
|
7358
7358
|
}
|
|
7359
7359
|
}
|
|
7360
7360
|
},
|
|
7361
|
-
"description": "Update an existing taggroup record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `id`.\n\n**See also:** `createTagGroup` (add new), `deleteTagGroup` (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._"
|
|
7361
|
+
"description": "Update an existing taggroup record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming a tag group.\n\n**Required:** `id`.\n\n**See also:** `createTagGroup` (add new), `deleteTagGroup` (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._"
|
|
7362
7362
|
}
|
|
7363
7363
|
},
|
|
7364
7364
|
"/api/v2/tag_groups/delete": {
|
|
@@ -7398,7 +7398,7 @@
|
|
|
7398
7398
|
}
|
|
7399
7399
|
}
|
|
7400
7400
|
},
|
|
7401
|
-
"description": "Permanently delete a taggroup record by ID. Destructive — cannot be undone via API.\n\n**Required:** `id`.\n\n**See also:** `updateTagGroup` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7401
|
+
"description": "Permanently delete a taggroup record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a group — child tags orphan; delete or re-group them first.\n\n**Required:** `id`.\n\n**See also:** `updateTagGroup` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7402
7402
|
}
|
|
7403
7403
|
},
|
|
7404
7404
|
"/api/v2/tag_types/get": {
|
|
@@ -7428,7 +7428,7 @@
|
|
|
7428
7428
|
}
|
|
7429
7429
|
}
|
|
7430
7430
|
},
|
|
7431
|
-
"description": "Paginated enumeration of tagtype records. Read-only.\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.\n\n**See also:** `getTagType` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7431
|
+
"description": "Paginated enumeration of tagtype records. Read-only.\n\n**Use when:** enumerating the tag-type classifiers on this site.\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.\n\n**See also:** `getTagType` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7432
7432
|
}
|
|
7433
7433
|
},
|
|
7434
7434
|
"/api/v2/tag_types/get/{id}": {
|
|
@@ -7460,7 +7460,7 @@
|
|
|
7460
7460
|
}
|
|
7461
7461
|
}
|
|
7462
7462
|
},
|
|
7463
|
-
"description": "Fetch a single tagtype record. Read-only.\n\n**Required:** `id`.\n\n**See also:** `listTagTypes` (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._"
|
|
7463
|
+
"description": "Fetch a single tagtype record. Read-only.\n\n**Use when:** one tag type by ID.\n\n**Required:** `id`.\n\n**See also:** `listTagTypes` (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._"
|
|
7464
7464
|
}
|
|
7465
7465
|
},
|
|
7466
7466
|
"/api/v2/tag_types/create": {
|
|
@@ -7504,7 +7504,7 @@
|
|
|
7504
7504
|
}
|
|
7505
7505
|
}
|
|
7506
7506
|
},
|
|
7507
|
-
"description": "Create a new tagtype record. Writes live data.\n\n**Required:** `type_name`, `table_relation`.\n\n**See also:** `updateTagType` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7507
|
+
"description": "Create a new tagtype record. Writes live data.\n\n**Use when:** adding a new tag classifier.\n\n**Required:** `type_name`, `table_relation`.\n\n**See also:** `updateTagType` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7508
7508
|
}
|
|
7509
7509
|
},
|
|
7510
7510
|
"/api/v2/tag_types/update": {
|
|
@@ -7547,7 +7547,7 @@
|
|
|
7547
7547
|
}
|
|
7548
7548
|
}
|
|
7549
7549
|
},
|
|
7550
|
-
"description": "Update an existing tagtype record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `id`.\n\n**See also:** `createTagType` (add new), `deleteTagType` (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._"
|
|
7550
|
+
"description": "Update an existing tagtype record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming or reconfiguring.\n\n**Required:** `id`.\n\n**See also:** `createTagType` (add new), `deleteTagType` (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._"
|
|
7551
7551
|
}
|
|
7552
7552
|
},
|
|
7553
7553
|
"/api/v2/tag_types/delete": {
|
|
@@ -7587,7 +7587,7 @@
|
|
|
7587
7587
|
}
|
|
7588
7588
|
}
|
|
7589
7589
|
},
|
|
7590
|
-
"description": "Permanently delete a tagtype record by ID. Destructive — cannot be undone via API.\n\n**Required:** `id`.\n\n**See also:** `updateTagType` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7590
|
+
"description": "Permanently delete a tagtype record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a tag type.\n\n**Required:** `id`.\n\n**See also:** `updateTagType` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7591
7591
|
}
|
|
7592
7592
|
},
|
|
7593
7593
|
"/api/v2/rel_tags/get": {
|
|
@@ -7617,7 +7617,7 @@
|
|
|
7617
7617
|
}
|
|
7618
7618
|
}
|
|
7619
7619
|
},
|
|
7620
|
-
"description": "Paginated enumeration of tagrelationship records. Read-only.\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.\n\n**See also:** `getTagRelationship` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7620
|
+
"description": "Paginated enumeration of tagrelationship records. Read-only.\n\n**Use when:** auditing which tags are attached to which records. Filter by tag or by target record.\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.\n\n**See also:** `getTagRelationship` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7621
7621
|
}
|
|
7622
7622
|
},
|
|
7623
7623
|
"/api/v2/rel_tags/get/{id}": {
|
|
@@ -7649,7 +7649,7 @@
|
|
|
7649
7649
|
}
|
|
7650
7650
|
}
|
|
7651
7651
|
},
|
|
7652
|
-
"description": "Fetch a single tagrelationship record. Read-only.\n\n**Required:** `id`.\n\n**See also:** `listTagRelationships` (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._"
|
|
7652
|
+
"description": "Fetch a single tagrelationship record. Read-only.\n\n**Use when:** one relationship row by ID.\n\n**Required:** `id`.\n\n**See also:** `listTagRelationships` (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._"
|
|
7653
7653
|
}
|
|
7654
7654
|
},
|
|
7655
7655
|
"/api/v2/rel_tags/create": {
|
|
@@ -7701,7 +7701,7 @@
|
|
|
7701
7701
|
}
|
|
7702
7702
|
}
|
|
7703
7703
|
},
|
|
7704
|
-
"description": "Create a new tagrelationship record. Writes live data.\n\n**Required:** `tag_id`, `object_id`, `tag_type_id`, `added_by`.\n\n**Parameter interactions:**\n- Attaches an existing tag to an existing record. Both sides must exist — use `listTags` and the target resource's list to discover IDs\n\n**See also:** `updateTagRelationship` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7704
|
+
"description": "Create a new tagrelationship record. Writes live data.\n\n**Use when:** attaching an existing tag to a record (member, post, etc.). The alternative for members is setting the `member_tags` field via `updateUser` with `member_tag_action=1`.\n\n**Required:** `tag_id`, `object_id`, `tag_type_id`, `added_by`.\n\n**Parameter interactions:**\n- Attaches an existing tag to an existing record. Both sides must exist — use `listTags` and the target resource's list to discover IDs\n\n**See also:** `updateTagRelationship` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7705
7705
|
}
|
|
7706
7706
|
},
|
|
7707
7707
|
"/api/v2/rel_tags/update": {
|
|
@@ -7744,7 +7744,7 @@
|
|
|
7744
7744
|
}
|
|
7745
7745
|
}
|
|
7746
7746
|
},
|
|
7747
|
-
"description": "Update an existing tagrelationship record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `id`.\n\n**See also:** `createTagRelationship` (add new), `deleteTagRelationship` (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._"
|
|
7747
|
+
"description": "Update an existing tagrelationship record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** adjusting a tag-relationship record's metadata.\n\n**Required:** `id`.\n\n**See also:** `createTagRelationship` (add new), `deleteTagRelationship` (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._"
|
|
7748
7748
|
}
|
|
7749
7749
|
},
|
|
7750
7750
|
"/api/v2/rel_tags/delete": {
|
|
@@ -7784,7 +7784,7 @@
|
|
|
7784
7784
|
}
|
|
7785
7785
|
}
|
|
7786
7786
|
},
|
|
7787
|
-
"description": "Permanently delete a tagrelationship record by ID. Destructive — cannot be undone via API.\n\n**Required:** `id`.\n\n**See also:** `updateTagRelationship` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7787
|
+
"description": "Permanently delete a tagrelationship record by ID. Destructive — cannot be undone via API.\n\n**Use when:** detaching a tag from a record. Note: if the member has `member_tags` CSV set, update that separately too.\n\n**Required:** `id`.\n\n**See also:** `updateTagRelationship` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
7788
7788
|
}
|
|
7789
7789
|
},
|
|
7790
7790
|
"/api/v2/smart_lists/get": {
|
|
@@ -7814,7 +7814,7 @@
|
|
|
7814
7814
|
}
|
|
7815
7815
|
}
|
|
7816
7816
|
},
|
|
7817
|
-
"description": "Paginated enumeration of smartlist records. Read-only.\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.\n\n**See also:** `getSmartList` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7817
|
+
"description": "Paginated enumeration of smartlist records. Read-only.\n\n**Use when:** enumerating saved dynamic filter configurations the admin has created — these back the BD admin's saved-filter UI for members, leads, reviews, etc.\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.\n\n**See also:** `getSmartList` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._"
|
|
7818
7818
|
}
|
|
7819
7819
|
},
|
|
7820
7820
|
"/api/v2/smart_lists/get/{smart_list_id}": {
|
|
@@ -7846,7 +7846,7 @@
|
|
|
7846
7846
|
}
|
|
7847
7847
|
}
|
|
7848
7848
|
},
|
|
7849
|
-
"description": "Fetch a single smartlist record. Read-only.\n\n**Required:** `smart_list_id`.\n\n**See also:** `listSmartLists` (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._"
|
|
7849
|
+
"description": "Fetch a single smartlist record. Read-only.\n\n**Use when:** fetching one saved filter's config.\n\n**Required:** `smart_list_id`.\n\n**See also:** `listSmartLists` (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._"
|
|
7850
7850
|
}
|
|
7851
7851
|
},
|
|
7852
7852
|
"/api/v2/smart_lists/create": {
|
|
@@ -7911,7 +7911,7 @@
|
|
|
7911
7911
|
}
|
|
7912
7912
|
}
|
|
7913
7913
|
},
|
|
7914
|
-
"description": "Create a new smartlist record. Writes live data.\n\n**Required:** `smart_list_name`, `smart_list_type`, `smart_list_created_by`.\n\n**Parameter interactions:**\n- `smart_list_type` — data source (see Enums)\n- `smart_list_created_by` — admin user ID creating the list\n- `smart_list_query_params` — JSON/string of filter criteria specific to the chosen type\n- `schedule` — recurrence if the list should auto-refresh\n\n**See also:** `updateSmartList` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7914
|
+
"description": "Create a new smartlist record. Writes live data.\n\n**Use when:** programmatically saving a filter configuration for later reuse. `smart_list_type` determines the data source (`members`, `leads`, `reviews`, etc.).\n\n**Required:** `smart_list_name`, `smart_list_type`, `smart_list_created_by`.\n\n**Parameter interactions:**\n- `smart_list_type` — data source (see Enums)\n- `smart_list_created_by` — admin user ID creating the list\n- `smart_list_query_params` — JSON/string of filter criteria specific to the chosen type\n- `schedule` — recurrence if the list should auto-refresh\n\n**See also:** `updateSmartList` (modify existing).\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: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._"
|
|
7915
7915
|
}
|
|
7916
7916
|
},
|
|
7917
7917
|
"/api/v2/smart_lists/update": {
|
|
@@ -7963,7 +7963,7 @@
|
|
|
7963
7963
|
}
|
|
7964
7964
|
}
|
|
7965
7965
|
},
|
|
7966
|
-
"description": "Update an existing smartlist record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `smart_list_id`.\n\n**See also:** `createSmartList` (add new), `deleteSmartList` (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._"
|
|
7966
|
+
"description": "Update an existing smartlist record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** editing the filter criteria or schedule on a saved list.\n\n**Required:** `smart_list_id`.\n\n**See also:** `createSmartList` (add new), `deleteSmartList` (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._"
|
|
7967
7967
|
}
|
|
7968
7968
|
},
|
|
7969
7969
|
"/api/v2/smart_lists/delete": {
|
|
@@ -8003,14 +8003,14 @@
|
|
|
8003
8003
|
}
|
|
8004
8004
|
}
|
|
8005
8005
|
},
|
|
8006
|
-
"description": "Permanently delete a smartlist record by ID. Destructive — cannot be undone via API.\n\n**Required:** `smart_list_id`.\n\n**See also:** `updateSmartList` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
8006
|
+
"description": "Permanently delete a smartlist record by ID. Destructive — cannot be undone via API.\n\n**Use when:** removing a saved filter configuration.\n\n**Required:** `smart_list_id`.\n\n**See also:** `updateSmartList` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
8007
8007
|
}
|
|
8008
8008
|
},
|
|
8009
8009
|
"/api/v2/list_seo/get": {
|
|
8010
8010
|
"get": {
|
|
8011
8011
|
"operationId": "listWebPages",
|
|
8012
8012
|
"summary": "List pages (list_seo)",
|
|
8013
|
-
"description": "Paginated enumeration of web pages (`list_seo` records). Read-only.\n\nReturns every static/SEO page on the site — homepage, about, contact, custom landing pages, templates, etc. Filter by `seo_type` to get pages of a specific type (e.g., only `content` pages).\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` token from the previous response's `next_page`.\n\n**Filter/sort:** standard `property` / `property_value` / `property_operator`; `order_column` + `order_type`.\n\n**See also:** `getWebPage` (single by ID), `createWebPage` (new page), `updateWebPage`.\n\n**Returns:** `{ status: \"success\", total, ..., message: [...records] }`. Each record has `seo_id`, `seo_type`, `filename`, `title`, `meta_desc`, `content`, `content_active`, plus all other page fields.\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._",
|
|
8013
|
+
"description": "Paginated enumeration of web pages (`list_seo` records). Read-only.\n\nReturns every static/SEO page on the site — homepage, about, contact, custom landing pages, templates, etc. Filter by `seo_type` to get pages of a specific type (e.g., only `content` pages).\n\n**Use when:** listing all site pages (homepage, about, contact, landing, templates). Filter by `seo_type` to scope (e.g., `content` for custom landing pages). For one page by `seo_id` use `getWebPage`.\n\n**Pagination:** cursor-based. Pass `limit` (default 25, max 100) and `page` token from the previous response's `next_page`.\n\n**Filter/sort:** standard `property` / `property_value` / `property_operator`; `order_column` + `order_type`.\n\n**See also:** `getWebPage` (single by ID), `createWebPage` (new page), `updateWebPage`.\n\n**Returns:** `{ status: \"success\", total, ..., message: [...records] }`. Each record has `seo_id`, `seo_type`, `filename`, `title`, `meta_desc`, `content`, `content_active`, plus all other page fields.\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._",
|
|
8014
8014
|
"tags": [
|
|
8015
8015
|
"Pages"
|
|
8016
8016
|
],
|
|
@@ -8066,14 +8066,14 @@
|
|
|
8066
8066
|
}
|
|
8067
8067
|
}
|
|
8068
8068
|
},
|
|
8069
|
-
"description": "Fetch a single web page by `seo_id`. Read-only.\n\n**Required:** `seo_id` (path).\n\n**See also:** `listWebPages` (enumerate), `updateWebPage` (modify).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }`.\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._"
|
|
8069
|
+
"description": "Fetch a single web page by `seo_id`. Read-only.\n\n**Use when:** fetching one page's full content + metadata. Common for \"let me read the current About page before editing it\" workflows.\n\n**Required:** `seo_id` (path).\n\n**See also:** `listWebPages` (enumerate), `updateWebPage` (modify).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }`.\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._"
|
|
8070
8070
|
}
|
|
8071
8071
|
},
|
|
8072
8072
|
"/api/v2/list_seo/create": {
|
|
8073
8073
|
"post": {
|
|
8074
8074
|
"operationId": "createWebPage",
|
|
8075
8075
|
"summary": "Create a page",
|
|
8076
|
-
"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**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_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._",
|
|
8076
|
+
"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_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._",
|
|
8077
8077
|
"tags": [
|
|
8078
8078
|
"Pages"
|
|
8079
8079
|
],
|
|
@@ -8591,7 +8591,7 @@
|
|
|
8591
8591
|
}
|
|
8592
8592
|
}
|
|
8593
8593
|
},
|
|
8594
|
-
"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**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_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
8594
|
+
"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_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
8595
8595
|
}
|
|
8596
8596
|
},
|
|
8597
8597
|
"/api/v2/list_seo/delete": {
|
|
@@ -8632,14 +8632,14 @@
|
|
|
8632
8632
|
}
|
|
8633
8633
|
}
|
|
8634
8634
|
},
|
|
8635
|
-
"description": "Permanently delete a web page by `seo_id`. Destructive — cannot be undone via API.\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._"
|
|
8635
|
+
"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._"
|
|
8636
8636
|
}
|
|
8637
8637
|
},
|
|
8638
8638
|
"/api/v2/redirect_301/get": {
|
|
8639
8639
|
"get": {
|
|
8640
8640
|
"operationId": "listRedirects",
|
|
8641
8641
|
"summary": "List redirects (301)",
|
|
8642
|
-
"description": "Paginated list of all 301 redirect rules on the site.\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.\n\n**See also:** `getRedirect` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._",
|
|
8642
|
+
"description": "Paginated list of all 301 redirect rules on the site.\n\n**Use when:** auditing existing 301 rules — useful before bulk URL changes to avoid duplicate rules, or when debugging why a URL unexpectedly redirects.\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.\n\n**See also:** `getRedirect` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._",
|
|
8643
8643
|
"tags": [
|
|
8644
8644
|
"Redirects"
|
|
8645
8645
|
],
|
|
@@ -8695,14 +8695,14 @@
|
|
|
8695
8695
|
}
|
|
8696
8696
|
}
|
|
8697
8697
|
},
|
|
8698
|
-
"description": "Fetch a single redirect record. Read-only.\n\n**Required:** `redirect_id`.\n\n**See also:** `listRedirects` (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._"
|
|
8698
|
+
"description": "Fetch a single redirect record. Read-only.\n\n**Use when:** investigating one specific redirect rule by `redirect_id`.\n\n**Required:** `redirect_id`.\n\n**See also:** `listRedirects` (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._"
|
|
8699
8699
|
}
|
|
8700
8700
|
},
|
|
8701
8701
|
"/api/v2/redirect_301/create": {
|
|
8702
8702
|
"post": {
|
|
8703
8703
|
"operationId": "createRedirect",
|
|
8704
8704
|
"summary": "Create a redirect",
|
|
8705
|
-
"description": "Create a new 301 redirect rule. type, old_filename, and new_filename are required.\n\n**Required:** `type`, `old_filename`, `new_filename`.\n\n**Parameter interactions:**\n- `type` — source category: `profile`, `post`, `category`, `custom`, etc.\n- `old_filename` / `new_filename` — URL paths relative to the domain root (not full URLs)\n- `db_id` — database record ID of the source content if the redirect ties to one; otherwise 0\n\n**See also:** `updateRedirect` (modify existing).\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._",
|
|
8705
|
+
"description": "Create a new 301 redirect rule. type, old_filename, and new_filename are required.\n\n**Use when:** preserving SEO after any URL change — slug rename on a member profile, post, page, or category. BD auto-creates some redirects on its own (admin-triggered renames), but you must create them manually for API-triggered changes. Avoid duplicate `old_filename` values.\n\n**Required:** `type`, `old_filename`, `new_filename`.\n\n**Parameter interactions:**\n- `type` — source category: `profile`, `post`, `category`, `custom`, etc.\n- `old_filename` / `new_filename` — URL paths relative to the domain root (not full URLs)\n- `db_id` — database record ID of the source content if the redirect ties to one; otherwise 0\n\n**See also:** `updateRedirect` (modify existing).\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._",
|
|
8706
8706
|
"tags": [
|
|
8707
8707
|
"Redirects"
|
|
8708
8708
|
],
|
|
@@ -8815,7 +8815,7 @@
|
|
|
8815
8815
|
}
|
|
8816
8816
|
}
|
|
8817
8817
|
},
|
|
8818
|
-
"description": "Update an existing redirect record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `redirect_id`.\n\n**See also:** `createRedirect` (add new), `deleteRedirect` (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._"
|
|
8818
|
+
"description": "Update an existing redirect record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** adjusting an existing rule's destination or source path. Rare — most redirects are create-once.\n\n**Required:** `redirect_id`.\n\n**See also:** `createRedirect` (add new), `deleteRedirect` (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._"
|
|
8819
8819
|
}
|
|
8820
8820
|
},
|
|
8821
8821
|
"/api/v2/redirect_301/delete": {
|
|
@@ -8856,14 +8856,14 @@
|
|
|
8856
8856
|
}
|
|
8857
8857
|
}
|
|
8858
8858
|
},
|
|
8859
|
-
"description": "Permanently delete a redirect record by ID. Destructive — cannot be undone via API.\n\n**Required:** `redirect_id`.\n\n**See also:** `updateRedirect` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
8859
|
+
"description": "Permanently delete a redirect record by ID. Destructive — cannot be undone via API.\n\n**Use when:** an old redirect is no longer needed (source content has been offline long enough that the 301 value is gone) or the rule is conflicting with a new page at the same path.\n\n**Required:** `redirect_id`.\n\n**See also:** `updateRedirect` (modify without removing).\n\n**Destructive:** confirm intent with the user before bulk use. No soft-delete via API — records removed are not recoverable.\n\n**Returns:** `{ status: \"success\", message: \"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._"
|
|
8860
8860
|
}
|
|
8861
8861
|
},
|
|
8862
8862
|
"/api/v2/website_settings/refreshCache": {
|
|
8863
8863
|
"post": {
|
|
8864
8864
|
"operationId": "refreshSiteCache",
|
|
8865
8865
|
"summary": "Refresh the site cache",
|
|
8866
|
-
"description": "Clears BD's internal caches for the site. IMPORTANT: this does NOT register newly-created page URLs with the router — a freshly created page via createWebPage will still 404 on the public site even after refreshCache. The only known way to fully activate a new page is manually clicking Save on the record in BD Admin > Manage Pages. This endpoint is useful for generic cache invalidation (e.g., after changes to templates, design settings, etc.), not for page propagation. Undocumented by BD publicly; exposed via admin API-permissions UI.\n\n**Parameter interactions:**\n- Clears BD's internal caches. Does NOT register newly-created page URLs with the public router (new pages created via `createWebPage` become live immediately via `content_active=1` + valid `seo_type`, not via this endpoint)\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
8866
|
+
"description": "Clears BD's internal caches for the site. IMPORTANT: this does NOT register newly-created page URLs with the router — a freshly created page via createWebPage will still 404 on the public site even after refreshCache. The only known way to fully activate a new page is manually clicking Save on the record in BD Admin > Manage Pages. This endpoint is useful for generic cache invalidation (e.g., after changes to templates, design settings, etc.), not for page propagation. Undocumented by BD publicly; exposed via admin API-permissions UI.\n\n**Use when:** you've made changes to templates, theme settings, or widgets and want to invalidate BD's internal cache. Does NOT register newly created page URLs with the router — pages created via `createWebPage` become live immediately via `content_active=1` + valid `seo_type`, not via this endpoint.\n\n**Parameter interactions:**\n- Clears BD's internal caches. Does NOT register newly-created page URLs with the public router (new pages created via `createWebPage` become live immediately via `content_active=1` + valid `seo_type`, not via this endpoint)\n\n**Returns:** `{ status: \"success\"|\"error\", message: ... }` — BD's standard response envelope.\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._",
|
|
8867
8867
|
"tags": [
|
|
8868
8868
|
"Website Settings"
|
|
8869
8869
|
],
|
|
@@ -8885,7 +8885,7 @@
|
|
|
8885
8885
|
"get": {
|
|
8886
8886
|
"operationId": "listDataTypes",
|
|
8887
8887
|
"summary": "List data types",
|
|
8888
|
-
"description": "List all data types configured on this BD site. Use the data_id values as data_type parameters when creating posts or portfolio groups.\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.\n\n**See also:** `getDataType` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._",
|
|
8888
|
+
"description": "List all data types configured on this BD site. Use the data_id values as data_type parameters when creating posts or portfolio groups.\n\n**Use when:** discovering the valid `data_type` values on the site. Used as a prerequisite lookup when creating posts or portfolio groups that need a `data_type` foreign-key value.\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.\n\n**See also:** `getDataType` (single record by ID).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record is the full resource object.\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._",
|
|
8889
8889
|
"tags": [
|
|
8890
8890
|
"Data Types"
|
|
8891
8891
|
],
|
|
@@ -8941,14 +8941,14 @@
|
|
|
8941
8941
|
}
|
|
8942
8942
|
}
|
|
8943
8943
|
},
|
|
8944
|
-
"description": "Fetch a single datatype record. Read-only.\n\n**Required:** `data_id`.\n\n**See also:** `listDataTypes` (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._"
|
|
8944
|
+
"description": "Fetch a single datatype record. Read-only.\n\n**Use when:** fetching one data type's record by ID.\n\n**Required:** `data_id`.\n\n**See also:** `listDataTypes` (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._"
|
|
8945
8945
|
}
|
|
8946
8946
|
},
|
|
8947
8947
|
"/api/v2/data_types/create": {
|
|
8948
8948
|
"post": {
|
|
8949
8949
|
"operationId": "createDataType",
|
|
8950
8950
|
"summary": "Create a data type",
|
|
8951
|
-
"description": "Define a new content-type template. Only do this when the user explicitly wants a new post type — most sites come pre-configured with the types they need.\n\n**Required:** `category_name`, `category_active`.\n\n**Enums:** `category_active`: `1`=active and available for members to use, `0`=inactive; `limit_available`: `0`, `1`.\n\n**See also:** `updateDataType` (modify existing).\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._",
|
|
8951
|
+
"description": "Define a new content-type template. Only do this when the user explicitly wants a new post type — most sites come pre-configured with the types they need.\n\n**Use when:** adding a new data-type classifier. Rare — usually preconfigured.\n\n**Required:** `category_name`, `category_active`.\n\n**Enums:** `category_active`: `1`=active and available for members to use, `0`=inactive; `limit_available`: `0`, `1`.\n\n**See also:** `updateDataType` (modify existing).\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\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._",
|
|
8952
8952
|
"tags": [
|
|
8953
8953
|
"Data Types"
|
|
8954
8954
|
],
|
|
@@ -9060,14 +9060,14 @@
|
|
|
9060
9060
|
}
|
|
9061
9061
|
}
|
|
9062
9062
|
},
|
|
9063
|
-
"description": "Update an existing datatype record by ID. Fields omitted are untouched. Writes live data.\n\n**Required:** `data_id`.\n\n**Enums:** `category_active`: `1`=active and available for members to use, `0`=inactive; `limit_available`: `0`, `1`.\n\n**See also:** `createDataType` (add new), `deleteDataType` (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._"
|
|
9063
|
+
"description": "Update an existing datatype record by ID. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming a data type.\n\n**Required:** `data_id`.\n\n**Enums:** `category_active`: `1`=active and available for members to use, `0`=inactive; `limit_available`: `0`, `1`.\n\n**See also:** `createDataType` (add new), `deleteDataType` (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._"
|
|
9064
9064
|
}
|
|
9065
9065
|
},
|
|
9066
9066
|
"/api/v2/data_types/delete": {
|
|
9067
9067
|
"delete": {
|
|
9068
9068
|
"operationId": "deleteDataType",
|
|
9069
9069
|
"summary": "Delete a data type",
|
|
9070
|
-
"description": "Deletes a data type definition. Records (posts, portfolio groups) referencing a deleted data type may become orphaned — confirm with the user before deleting.\n\n**Required:** `data_id`.\n\n**See also:** `updateDataType` (modify without removing).\n\n**Returns:** `{ status: \"success\", message: \"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._",
|
|
9070
|
+
"description": "Deletes a data type definition. Records (posts, portfolio groups) referencing a deleted data type may become orphaned — confirm with the user before deleting.\n\n**Use when:** removing an unused data type. Posts/groups referencing it orphan — clean up first.\n\n**Required:** `data_id`.\n\n**See also:** `updateDataType` (modify without removing).\n\n**Returns:** `{ status: \"success\", message: \"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._",
|
|
9071
9071
|
"tags": [
|
|
9072
9072
|
"Data Types"
|
|
9073
9073
|
],
|
|
@@ -9131,7 +9131,7 @@
|
|
|
9131
9131
|
}
|
|
9132
9132
|
}
|
|
9133
9133
|
},
|
|
9134
|
-
"description": "Paginated enumeration of TOP-level member categories. Read-only.\n\nTop Categories are the highest level of the 3-tier member classification (e.g., \"Restaurants\", \"Dentists\"). Each record's `profession_id` is what populates `users_data.profession_id` on member records. Backed by BD's `list_professions` table.\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.\n\n**See also:** `getTopCategory` (single by ID), `listSubCategories` (sub-categories filtered by `profession_id`), `createTopCategory` (add new).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record has `profession_id`, `name`, `desc`, `filename`, `keywords`, `icon`, `sort_order`, `lead_price`, `image`, `revision_timestamp`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9134
|
+
"description": "Paginated enumeration of TOP-level member categories. Read-only.\n\nTop Categories are the highest level of the 3-tier member classification (e.g., \"Restaurants\", \"Dentists\"). Each record's `profession_id` is what populates `users_data.profession_id` on member records. Backed by BD's `list_professions` table.\n\n**Use when:** populating a category dropdown, generating a site map, or discovering the `profession_id` of an existing category before assigning members to it. Returns ALL top-level categories. For sub-categories under a specific top, use `listSubCategories` with a `profession_id` filter.\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.\n\n**See also:** `getTopCategory` (single by ID), `listSubCategories` (sub-categories filtered by `profession_id`), `createTopCategory` (add new).\n\n**Returns:** `{ status: \"success\", total, current_page, total_pages, next_page, prev_page, message: [...records] }`. Each record has `profession_id`, `name`, `desc`, `filename`, `keywords`, `icon`, `sort_order`, `lead_price`, `image`, `revision_timestamp`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9135
9135
|
}
|
|
9136
9136
|
},
|
|
9137
9137
|
"/api/v2/list_professions/get/{profession_id}": {
|
|
@@ -9163,7 +9163,7 @@
|
|
|
9163
9163
|
}
|
|
9164
9164
|
}
|
|
9165
9165
|
},
|
|
9166
|
-
"description": "Fetch a single TOP-level member category by `profession_id`. Read-only.\n\nA Top Category is the highest level of the 3-tier member classification. Backed by BD's `list_professions` table.\n\n**Required:** `profession_id` (path parameter).\n\n**See also:** `listTopCategories` (enumerate), `listSubCategories` (sub-categories under this one; filter by `profession_id`).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }` — array of 1 record with full fields.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9166
|
+
"description": "Fetch a single TOP-level member category by `profession_id`. Read-only.\n\nA Top Category is the highest level of the 3-tier member classification. Backed by BD's `list_professions` table.\n\n**Use when:** you already have a `profession_id` and need its full record (name, filename, etc.). For enumeration use `listTopCategories`.\n\n**Required:** `profession_id` (path parameter).\n\n**See also:** `listTopCategories` (enumerate), `listSubCategories` (sub-categories under this one; filter by `profession_id`).\n\n**Returns:** `{ status: \"success\", message: [{...record}] }` — array of 1 record with full fields.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9167
9167
|
}
|
|
9168
9168
|
},
|
|
9169
9169
|
"/api/v2/list_professions/create": {
|
|
@@ -9233,7 +9233,7 @@
|
|
|
9233
9233
|
}
|
|
9234
9234
|
}
|
|
9235
9235
|
},
|
|
9236
|
-
"description": "Create a new TOP-level member category. Writes live data.\n\nA Top Category is the highest level of the 3-tier member classification (e.g., \"Restaurants\"). It populates the `profession_id` field on user records. Backed by BD's `list_professions` table.\n\n**Required:** `name`, `filename`.\n\n**Parameter guidance:**\n- `name` — human-readable (e.g. \"Restaurants\", \"Dentists\")\n- `filename` — URL-slug form (e.g. \"restaurants\") used in public member profile URLs\n- `desc`, `keywords`, `icon`, `sort_order`, `lead_price`, `image` — all optional\n\n**See also:** `listTopCategories` (list all), `getTopCategory` (by ID), `createSubCategory` (add a sub-category under this top).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` including the new `profession_id`. Use that value to populate `users_data.profession_id` on member records.\n\n**Common workflow — full 3-tier setup (\"create Restaurants → Sushi → assign Alice\"):**\n\n1. `createTopCategory` with `name=\"Restaurants\"`, `filename=\"restaurants\"` → returns `profession_id` (e.g. 42)\n2. `createSubCategory` with `name=\"Sushi\"`, `profession_id=42`, `filename=\"sushi\"` → returns `service_id` (e.g. 17)\n3. Assign Alice: `updateUser` with `user_id=<Alice>`, `profession_id=42`, `services=\"17\"` (simple), OR `createMemberSubCategoryLink` with `user_id=<Alice>`, `service_id=17`, `avg_price=...`, `specialty=1` (with per-link metadata)\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9236
|
+
"description": "Create a new TOP-level member category. Writes live data.\n\nA Top Category is the highest level of the 3-tier member classification (e.g., \"Restaurants\"). It populates the `profession_id` field on user records. Backed by BD's `list_professions` table.\n\n**Use when:** explicitly building out the site's taxonomy BEFORE members exist. If you're creating members and want categories to be auto-created by name, skip this and pass `profession_name` directly to `createUser` — BD auto-creates missing top-level categories on member-create.\n\n**Required:** `name`, `filename`.\n\n**Parameter guidance:**\n- `name` — human-readable (e.g. \"Restaurants\", \"Dentists\")\n- `filename` — URL-slug form (e.g. \"restaurants\") used in public member profile URLs\n- `desc`, `keywords`, `icon`, `sort_order`, `lead_price`, `image` — all optional\n\n**See also:** `listTopCategories` (list all), `getTopCategory` (by ID), `createSubCategory` (add a sub-category under this top).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` including the new `profession_id`. Use that value to populate `users_data.profession_id` on member records.\n\n**Common workflow — full 3-tier setup (\"create Restaurants → Sushi → assign Alice\"):**\n\n1. `createTopCategory` with `name=\"Restaurants\"`, `filename=\"restaurants\"` → returns `profession_id` (e.g. 42)\n2. `createSubCategory` with `name=\"Sushi\"`, `profession_id=42`, `filename=\"sushi\"` → returns `service_id` (e.g. 17)\n3. Assign Alice: `updateUser` with `user_id=<Alice>`, `profession_id=42`, `services=\"17\"` (simple), OR `createMemberSubCategoryLink` with `user_id=<Alice>`, `service_id=17`, `avg_price=...`, `specialty=1` (with per-link metadata)\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9237
9237
|
}
|
|
9238
9238
|
},
|
|
9239
9239
|
"/api/v2/list_professions/update": {
|
|
@@ -9298,7 +9298,7 @@
|
|
|
9298
9298
|
}
|
|
9299
9299
|
}
|
|
9300
9300
|
},
|
|
9301
|
-
"description": "Update an existing TOP-level member category by `profession_id`. Fields omitted are untouched. Writes live data.\n\n**Required:** `profession_id`.\n\n**See also:** `createTopCategory` (add new), `deleteTopCategory` (remove).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9301
|
+
"description": "Update an existing TOP-level member category by `profession_id`. Fields omitted are untouched. Writes live data.\n\n**Use when:** renaming a category, changing its URL slug (`filename`), updating SEO keywords, or reordering. Changing `filename` breaks inbound links — also create a `Redirect` via `createRedirect` to preserve SEO.\n\n**Required:** `profession_id`.\n\n**See also:** `createTopCategory` (add new), `deleteTopCategory` (remove).\n\n**Writes live data:** changes are immediately visible on the public site.\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9302
9302
|
}
|
|
9303
9303
|
},
|
|
9304
9304
|
"/api/v2/list_professions/delete": {
|
|
@@ -9339,7 +9339,7 @@
|
|
|
9339
9339
|
}
|
|
9340
9340
|
}
|
|
9341
9341
|
},
|
|
9342
|
-
"description": "Permanently delete a TOP-level member category by `profession_id`. Destructive — cannot be undone via API.\n\n**Required:** `profession_id`.\n\n**Destructive:** confirm intent with the user. Members who referenced this `profession_id` will have orphan references. Sub Categories under this top (with matching `profession_id` in `list_services`) also become orphaned — consider reassigning or deleting them first.\n\n**See also:** `updateTopCategory` (modify without removing).\n\n**Returns:** `{ status: \"success\", message: \"list_professions record was deleted\" }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9342
|
+
"description": "Permanently delete a TOP-level member category by `profession_id`. Destructive — cannot be undone via API.\n\n**Use when:** removing an unused top-level category. Any members with matching `profession_id` become orphaned — reassign them first. Any Sub Categories (`list_services` rows) under this top also orphan — delete or re-parent them.\n\n**Required:** `profession_id`.\n\n**Destructive:** confirm intent with the user. Members who referenced this `profession_id` will have orphan references. Sub Categories under this top (with matching `profession_id` in `list_services`) also become orphaned — consider reassigning or deleting them first.\n\n**See also:** `updateTopCategory` (modify without removing).\n\n**Returns:** `{ status: \"success\", message: \"list_professions record was deleted\" }`.\n\n\n---\n\n**Member Category Hierarchy (3 levels):**\n\nBD classifies members through a 3-level taxonomy — AI agents MUST understand all three to correctly create, assign, and query member categories:\n\n| Level | Tool nicknames | Endpoint | BD internal table | Key field | Parent reference |\n|---|---|---|---|---|---|\n| **1. Top Category** | `listTopCategories`, `createTopCategory`, etc. | `/api/v2/list_professions/*` | `list_professions` | `profession_id` (PK) | — |\n| **2. Sub Category** | `listSubCategories`, `createSubCategory`, etc. | `/api/v2/list_services/*` | `list_services` | `service_id` (PK) | `profession_id` → parent Top Category; `master_id` → parent Sub Category (for sub-sub nesting; 0 = direct child of Top) |\n| **3. Member ↔ Sub Category link** | `listMemberSubCategoryLinks`, `createMemberSubCategoryLink`, etc. | `/api/v2/rel_services/*` | `rel_services` | `rel_id` (PK) | `user_id` → member; `service_id` → Sub Category |\n\n**How a member gets classified on their public profile:**\n- `users_data.profession_id` → points at a single Top Category (the member's primary classification; shown in URL slug)\n- `users_data.services` → CSV of Sub Category IDs the member is tagged with (multiple allowed; simpler than the join table)\n- `rel_services` rows (Member ↔ Sub Category links) → used when you need per-link metadata like `avg_price`, `specialty`, `num_completed`. Optional; most sites use just the CSV field.\n\n**Sub-sub-categories:** `createSubCategory` with `master_id=<parent service_id>` creates a Sub Category nested under another Sub Category (a \"sub-sub\"). `master_id=0` (default) means the Sub Category sits directly under a Top Category (the `profession_id`).\n\n**There is NO `createProfession` or `createService` tool in this MCP** — those are the BD internal resource names. Use the tools named above.\n\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._"
|
|
9343
9343
|
}
|
|
9344
9344
|
}
|
|
9345
9345
|
},
|