brilliant-directories-mcp 5.3.2 → 6.0.1
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 +34 -72
- package/package.json +1 -1
package/openapi/bd-api.json
CHANGED
|
@@ -4043,59 +4043,6 @@
|
|
|
4043
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
|
-
"/api/v2/data_categories/create": {
|
|
4047
|
-
"post": {
|
|
4048
|
-
"operationId": "createPostType",
|
|
4049
|
-
"summary": "Create a post type",
|
|
4050
|
-
"tags": [
|
|
4051
|
-
"Post Types"
|
|
4052
|
-
],
|
|
4053
|
-
"requestBody": {
|
|
4054
|
-
"required": true,
|
|
4055
|
-
"content": {
|
|
4056
|
-
"application/x-www-form-urlencoded": {
|
|
4057
|
-
"schema": {
|
|
4058
|
-
"type": "object",
|
|
4059
|
-
"required": [
|
|
4060
|
-
"data_name"
|
|
4061
|
-
],
|
|
4062
|
-
"properties": {
|
|
4063
|
-
"data_name": {
|
|
4064
|
-
"type": "string"
|
|
4065
|
-
},
|
|
4066
|
-
"data_active": {
|
|
4067
|
-
"type": "integer",
|
|
4068
|
-
"enum": [
|
|
4069
|
-
0,
|
|
4070
|
-
1
|
|
4071
|
-
]
|
|
4072
|
-
},
|
|
4073
|
-
"category_tab": {
|
|
4074
|
-
"type": "string"
|
|
4075
|
-
},
|
|
4076
|
-
"profile_tab": {
|
|
4077
|
-
"type": "string"
|
|
4078
|
-
}
|
|
4079
|
-
}
|
|
4080
|
-
}
|
|
4081
|
-
}
|
|
4082
|
-
}
|
|
4083
|
-
},
|
|
4084
|
-
"responses": {
|
|
4085
|
-
"200": {
|
|
4086
|
-
"description": "Post type created",
|
|
4087
|
-
"content": {
|
|
4088
|
-
"application/json": {
|
|
4089
|
-
"schema": {
|
|
4090
|
-
"$ref": "#/components/schemas/SuccessResponse"
|
|
4091
|
-
}
|
|
4092
|
-
}
|
|
4093
|
-
}
|
|
4094
|
-
}
|
|
4095
|
-
},
|
|
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
|
-
}
|
|
4098
|
-
},
|
|
4099
4046
|
"/api/v2/data_categories/custom_fields": {
|
|
4100
4047
|
"post": {
|
|
4101
4048
|
"operationId": "getPostTypeCustomFields",
|
|
@@ -4179,7 +4126,7 @@
|
|
|
4179
4126
|
}
|
|
4180
4127
|
}
|
|
4181
4128
|
},
|
|
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:** `
|
|
4129
|
+
"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:** `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
4130
|
}
|
|
4184
4131
|
},
|
|
4185
4132
|
"/api/v2/data_categories/delete": {
|
|
@@ -4303,7 +4250,8 @@
|
|
|
4303
4250
|
"properties": {
|
|
4304
4251
|
"email": {
|
|
4305
4252
|
"type": "string",
|
|
4306
|
-
"format": "email"
|
|
4253
|
+
"format": "email",
|
|
4254
|
+
"description": "Email address to unsubscribe from ALL site emails. BD unsubscribe is SITE-WIDE scope — no way to unsub from some lists but not others via this endpoint. Adds the email to the global unsubscribe table."
|
|
4307
4255
|
},
|
|
4308
4256
|
"definitive": {
|
|
4309
4257
|
"type": "integer",
|
|
@@ -4330,7 +4278,7 @@
|
|
|
4330
4278
|
}
|
|
4331
4279
|
}
|
|
4332
4280
|
},
|
|
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._"
|
|
4281
|
+
"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**`email` is the only meaningful input.** Pass the email address to opt out. BD adds unsubscribe records to its global unsubscribe list — this applies across all email campaigns for the site. There is no \"unsubscribe from some lists but not others\" granularity via this endpoint; it's all-or-nothing.\n\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
4282
|
}
|
|
4335
4283
|
},
|
|
4336
4284
|
"/api/v2/unsubscribe_list/update": {
|
|
@@ -4835,7 +4783,7 @@
|
|
|
4835
4783
|
}
|
|
4836
4784
|
}
|
|
4837
4785
|
},
|
|
4838
|
-
"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._"
|
|
4786
|
+
"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**On create: `email_name` is the only required field.** Subject and body are optional at create time — you can create a template stub and fill in `email_subject` / `email_body` via `updateEmailTemplate` later. This lets you programmatically scaffold templates before customizing them via the admin UI.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
4839
4787
|
}
|
|
4840
4788
|
},
|
|
4841
4789
|
"/api/v2/email_templates/update": {
|
|
@@ -5028,15 +4976,26 @@
|
|
|
5028
4976
|
},
|
|
5029
4977
|
"form_action": {
|
|
5030
4978
|
"type": "string",
|
|
5031
|
-
"default": "post"
|
|
4979
|
+
"default": "post",
|
|
4980
|
+
"enum": [
|
|
4981
|
+
"post",
|
|
4982
|
+
"get"
|
|
4983
|
+
],
|
|
4984
|
+
"description": "**post** = form submits via POST body (default, most forms). **get** = form submits as URL query string (use for bookmarkable search/filter forms)."
|
|
5032
4985
|
},
|
|
5033
4986
|
"form_layout": {
|
|
5034
4987
|
"type": "string",
|
|
5035
|
-
"default": "
|
|
4988
|
+
"default": "bootstrapvertical",
|
|
4989
|
+
"enum": [
|
|
4990
|
+
"bootstrapvertical",
|
|
4991
|
+
"bootstrap"
|
|
4992
|
+
],
|
|
4993
|
+
"description": "**bootstrapvertical** = Labels Above Inputs (default). **bootstrap** = Labels Left of Inputs."
|
|
5036
4994
|
},
|
|
5037
4995
|
"form_table": {
|
|
5038
4996
|
"type": "string",
|
|
5039
|
-
"description": "
|
|
4997
|
+
"description": "Database table the form submissions post into. Default: `website_contacts`. Override only when building a form that posts into a different BD table.",
|
|
4998
|
+
"default": "website_contacts"
|
|
5040
4999
|
},
|
|
5041
5000
|
"form_class": {
|
|
5042
5001
|
"type": "string"
|
|
@@ -5068,7 +5027,7 @@
|
|
|
5068
5027
|
}
|
|
5069
5028
|
}
|
|
5070
5029
|
},
|
|
5071
|
-
"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._"
|
|
5030
|
+
"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**Field defaults and valid values (from BD admin form-builder UI, confirmed 2026-04-18):**\n- `form_action` — `post` (default, form submits via POST) or `get` (form submits via URL query string). Most forms use `post`; use `get` only for search/filter forms where the submission should be bookmarkable.\n- `form_layout` — `bootstrapvertical` (default; Labels Above Inputs) or `bootstrap` (Labels Left of Inputs).\n- `form_table` — the database table submissions are posted into. Default: `website_contacts`. Override only when building a form that posts into a different BD table (rare; usually a custom workflow).\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
5072
5031
|
}
|
|
5073
5032
|
},
|
|
5074
5033
|
"/api/v2/form/update": {
|
|
@@ -5246,11 +5205,11 @@
|
|
|
5246
5205
|
},
|
|
5247
5206
|
"field_name": {
|
|
5248
5207
|
"type": "string",
|
|
5249
|
-
"description": "
|
|
5208
|
+
"description": "Internal system key for this field. **Underscores only, no spaces** — e.g. `first_name`, `company_email`. Used as the HTML `name` attribute."
|
|
5250
5209
|
},
|
|
5251
5210
|
"field_text": {
|
|
5252
5211
|
"type": "string",
|
|
5253
|
-
"description": "
|
|
5212
|
+
"description": "Public-facing display label shown to the user. Free-form text — e.g. \"First Name\", \"Your Email Address\"."
|
|
5254
5213
|
},
|
|
5255
5214
|
"field_type": {
|
|
5256
5215
|
"type": "string",
|
|
@@ -5287,7 +5246,7 @@
|
|
|
5287
5246
|
"Category",
|
|
5288
5247
|
"Years"
|
|
5289
5248
|
],
|
|
5290
|
-
"description": "Form field type.
|
|
5249
|
+
"description": "Form field type. See full list grouped by category (Select / Text inputs / Fancy fields) in the tool description."
|
|
5291
5250
|
},
|
|
5292
5251
|
"field_order": {
|
|
5293
5252
|
"type": "integer"
|
|
@@ -5331,7 +5290,7 @@
|
|
|
5331
5290
|
}
|
|
5332
5291
|
}
|
|
5333
5292
|
},
|
|
5334
|
-
"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._"
|
|
5293
|
+
"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**`field_type` valid values (BD admin form-builder UI, full list):**\n\n*Select-type fields:* `Checkbox` (checkboxes), `Select` (dropdown list), `Radio` (radio buttons), `YesNo` (yes/no toggle)\n\n*Text inputs:* `Custom` (custom HTML), `Email`, `HTML` (section title / heading), `Button` (submit button), `Textbox` (single-line text), `textarea` (paragraph), `Url` (website URL)\n\n*Fancy fields:* `Date` (date picker), `DateTimeLocal` (date + time picker), `File` (file upload), `FroalaEditor` (rich text — basic), `FroalaEditorUserUpload` (+ image upload), `FroalaEditorUserUploadPreMadeElem` (+ pre-made elements), `FroalaEditorAdmin` (+ media manager), `Tip` (help alert box), `Hidden`, `Country` (country list), `State` (state list), `Number` (integer), `Password`, `Phone`, `CountryCodePhone`, `Pricebox`, `ReCaptcha` (Google reCAPTCHA), `HoneyPot` (spam protection), `Category` (top-level category list), `Years` (year picker)\n\n**Field naming rules:**\n- `field_name` — internal system key. **Underscores only, no spaces.** E.g. `first_name`, `company_email`. Used as HTML `name` attribute.\n- `field_text` — public-facing display label shown to form users. Free-form, e.g. \"First Name\", \"Your Email Address\".\n\n**Form composition rule:** a form should have **exactly ONE `Button` field** (the submit trigger). Adding multiple Button fields causes UI confusion.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
5335
5294
|
}
|
|
5336
5295
|
},
|
|
5337
5296
|
"/api/v2/form_fields/update": {
|
|
@@ -7677,10 +7636,12 @@
|
|
|
7677
7636
|
"type": "string"
|
|
7678
7637
|
},
|
|
7679
7638
|
"object_id": {
|
|
7680
|
-
"type": "integer"
|
|
7639
|
+
"type": "integer",
|
|
7640
|
+
"description": "Primary key of the record being tagged. Which table it lives in depends on tag_type_id — look up via listTagTypes. For tag_type_id=1 (Users), object_id is a user_id from users_data."
|
|
7681
7641
|
},
|
|
7682
7642
|
"tag_type_id": {
|
|
7683
|
-
"type": "integer"
|
|
7643
|
+
"type": "integer",
|
|
7644
|
+
"description": "Tag type classifier ID — determines which TABLE the object_id references. Call listTagTypes first to see the tag_type_id to table_relation mapping. Common example: tag_type_id=1 usually means Users (table_relation=users_data), so object_id would be a user_id. Other tag types may target widgets, menus, forms."
|
|
7684
7645
|
},
|
|
7685
7646
|
"added_by": {
|
|
7686
7647
|
"type": "integer"
|
|
@@ -7702,7 +7663,7 @@
|
|
|
7702
7663
|
}
|
|
7703
7664
|
}
|
|
7704
7665
|
},
|
|
7705
|
-
"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._"
|
|
7666
|
+
"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**`tag_type_id` + `object_id` — how to target the right record (from BD `tag_types` table):**\n\nThe `tag_type_id` determines WHICH resource/table the `object_id` lives in. Discover mapping via `listTagTypes` — each tag type row has a `table_relation` field naming its target table. Example mapping:\n\n| tag_type_id | type_name | Target table (table_relation) | What object_id references |\n|---|---|---|---|\n| 1 | Users | `users_data` | `user_id` |\n| (other rows) | (other types) | e.g. `data_widgets`, `menus`, `forms` | That table's primary key |\n\n**Process:** call `listTagTypes` first to see the `tag_type_id` → `table_relation` mapping on your site, then pick the appropriate `tag_type_id` and supply the matching record's PK as `object_id`. Widgets, menus, and forms all support tags via this same mechanism.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7706
7667
|
}
|
|
7707
7668
|
},
|
|
7708
7669
|
"/api/v2/rel_tags/update": {
|
|
@@ -7889,7 +7850,7 @@
|
|
|
7889
7850
|
},
|
|
7890
7851
|
"smart_list_query_params": {
|
|
7891
7852
|
"type": "string",
|
|
7892
|
-
"description": "Filter criteria"
|
|
7853
|
+
"description": "Filter criteria. Format depends on smart_list_type: for newsletter type, pass a URL string (used directly as href). For all other types (members, leads, reviews, transaction, forms_inbox), pass a JSON string of filter key-value pairs like {\"subscription_id\":\"1\",\"active\":\"1\"}. If no filters, pass \"NA\". Backend encrypts internally — do NOT pre-encrypt client-side."
|
|
7893
7854
|
},
|
|
7894
7855
|
"schedule": {
|
|
7895
7856
|
"type": "string",
|
|
@@ -7912,7 +7873,7 @@
|
|
|
7912
7873
|
}
|
|
7913
7874
|
}
|
|
7914
7875
|
},
|
|
7915
|
-
"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._"
|
|
7876
|
+
"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**`smart_list_query_params` format depends on `smart_list_type`:**\n\n- For `smart_list_type=newsletter`: store a URL string (admin view uses it directly as an href link — no filter semantics).\n- For ALL other types (`members`, `leads`, `reviews`, `transaction`, `forms_inbox`): pass a **JSON string of filter key-value pairs**, e.g. `{\"subscription_id\":\"1\",\"active\":\"1\"}`. The backend encrypts it internally before storing.\n- If empty / no filters: pass `\"NA\"` (the controller defaults missing values to this).\n\nThe API accepts the value as a plain string; BD handles the internal encryption. Don't pre-encrypt client-side — you'll get double-encrypted garbage. Use the JSON-key-value format for filterable types.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
7916
7877
|
}
|
|
7917
7878
|
},
|
|
7918
7879
|
"/api/v2/smart_lists/update": {
|
|
@@ -8703,7 +8664,7 @@
|
|
|
8703
8664
|
"post": {
|
|
8704
8665
|
"operationId": "createRedirect",
|
|
8705
8666
|
"summary": "Create a redirect",
|
|
8706
|
-
"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._",
|
|
8667
|
+
"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**`type` default: `custom`** — use `custom` unless you're explicitly mirroring BD's auto-generated redirect types (`profile`, `post`, `category`). Most API-created redirects should use `custom` since they're not tied to an auto-rename event from the BD admin UI.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._",
|
|
8707
8668
|
"tags": [
|
|
8708
8669
|
"Redirects"
|
|
8709
8670
|
],
|
|
@@ -8721,7 +8682,8 @@
|
|
|
8721
8682
|
"properties": {
|
|
8722
8683
|
"type": {
|
|
8723
8684
|
"type": "string",
|
|
8724
|
-
"description": "
|
|
8685
|
+
"description": "Redirect type category. Default: `custom` for API-created redirects. Other values (`profile`, `post`, `category`) are typically set by BD's auto-redirect logic on admin-triggered renames.",
|
|
8686
|
+
"default": "custom"
|
|
8725
8687
|
},
|
|
8726
8688
|
"old_filename": {
|
|
8727
8689
|
"type": "string",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "brilliant-directories-mcp",
|
|
3
3
|
"mcpName": "io.github.brilliantdirectories/brilliant-directories-mcp",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "6.0.1",
|
|
5
5
|
"description": "Official MCP server for Brilliant Directories — manage members, posts, leads, reviews, and more.",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"bin": {
|