# Brilliant Directories

Brilliant Directories is an all-in-one platform that enables users to create and manage online membership communities and business directories.

- **Category:** website builders
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 44
- **Triggers:** 0
- **Slug:** `BRILLIANT_DIRECTORIES`
- **Version:** 20260217_00

## Tools

### Create Album Photo

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_ALBUM_PHOTO`

Tool to add a new album photo to a user's portfolio in Brilliant Directories. Use when you need to upload or create a photo entry in a user's album. Required fields are user_id (the owner of the album) and title (photo title). Optional fields include description, status, keywords, file paths, and various metadata for organizing and categorizing photos. Supports e-commerce features like price, availability, and product information. The API endpoint expects application/x-www-form-urlencoded data and returns the created photo data with a generated photo_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `desc` | string | No | Description of the album photo |
| `file` | string | No | Path to the full-size image file |
| `link` | string | No | External link URL associated with the photo |
| `order` | integer | No | Display order for sorting photos in the album |
| `price` | number | No | Price associated with the photo (for e-commerce functionality) |
| `title` | string | Yes | The title of the album photo |
| `inv_id` | string | No | Inventory ID (for product photos) |
| `status` | integer | No | Status of the photo (0 = Inactive, 1 = Active) |
| `data_id` | integer | No | Associated data ID for the photo |
| `orgfile` | string | No | Original filename of the uploaded image |
| `room_id` | integer | No | ID of the room this photo belongs to |
| `user_id` | integer | Yes | The ID of the user who owns the album. Required field. |
| `group_id` | integer | No | ID of the group this photo belongs to |
| `keywords` | string | No | Keywords associated with the photo for search and categorization |
| `condition` | string | No | Condition description of the photo (for e-commerce functionality) |
| `data_type` | integer | No | Type of data associated with the photo |
| `thumbnail` | string | No | Path to the thumbnail image file |
| `group_cover` | integer | No | Whether this photo is the group cover image (0 = No, 1 = Yes) |
| `photo_token` | string | No | Unique token identifier for the photo |
| `availability` | string | No | Availability status of the photo (for e-commerce functionality) |
| `manufacturer` | string | No | Manufacturer information (for product photos) |
| `product_type` | string | No | Type of product (for product photos) |
| `image_imported` | string | No | Import status of the image (0 = Not imported, 1 = Basic import, 2 = Advanced import) |
| `photo_filename` | string | No | Filename for the photo stored in the system |
| `reason_inactive` | string | No | Reason why the photo is inactive, if applicable |
| `photo_date_added` | string | No | Date and time when the photo was added (format: YYYYMMDDHHMMSS) |
| `product_category` | string | No | Category of product (for product photos) |
| `additional_fields` | string | No | JSON string containing additional custom fields |
| `facebook_photo_id` | string | No | Facebook photo ID if imported from Facebook |
| `original_image_url` | string | No | URL of the original image if imported from external source |
| `photo_date_updated` | string | No | Date and time when the photo was last updated (format: YYYYMMDDHHMMSS) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Category

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_DATA_CATEGORY`

Creates a new data category (post type) in the Brilliant Directories website database. Post types are content types like Videos, Articles, Jobs, Events, Coupons, Classifieds, etc. Required fields: data_name (display name), data_filename (identifier), system_name (system identifier), data_type (numeric type), and form_name (associated form fields name). Optional fields include display configuration (h1, h2, icon, caption_length), sorting options (category_order_by, profile_order_by), pagination (per_page, profile_per_page), layout settings (category_sidebar, profile_sidebar, search_results_layout), and many other customization options. Returns success status with the created data category information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `h1` | string | No | H1 heading text for the post type page |
| `h2` | string | No | H2 heading text for the post type page |
| `icon` | string | No | Icon HTML/class for the post type (e.g., FontAwesome icon) |
| `data_id` | integer | No | Primary key identifier (typically auto-generated, leave empty for new records) |
| `comments` | string | No | Whether comments are enabled (0 for disabled, 1 for enabled) |
| `per_page` | integer | No | Number of items to display per page in listings |
| `always_on` | integer | No | Whether the post type is always enabled |
| `data_name` | string | Yes | The display name of the post type (e.g., 'Classified', 'Event') |
| `data_type` | integer | Yes | The numeric type identifier for the post type (e.g., 4 for custom post types) |
| `form_name` | string | Yes | The name of the form/fields associated with this post type (e.g., 'test_fields', 'classified_fields') |
| `post_date` | string | No | Date format or configuration for posts |
| `post_type` | string | No | Additional post type configuration |
| `data_active` | string | No | Whether the post type is active (1 for active, 0 for inactive) |
| `profile_tab` | string | No | Tab name for profile navigation |
| `system_name` | string | Yes | The system identifier for the post type, typically matches data_filename (e.g., 'test_category', 'classified') |
| `category_sql` | string | No | Custom SQL query for category filtering |
| `category_tab` | string | No | Tab name for category navigation |
| `comments_code` | string | No | Custom code for comments integration |
| `data_filename` | string | Yes | The filename identifier for the post type, typically lowercase with underscores (e.g., 'test_category', 'classified') |
| `display_order` | integer | No | Display order for sorting post types |
| `caption_length` | integer | No | Maximum length for captions/excerpts |
| `category_group` | integer | No | Category group identifier |
| `footer_content` | string | No | HTML/text content for the footer |
| `profile_footer` | string | No | Footer content for profile pages |
| `profile_header` | string | No | Header content for profile pages |
| `search_results` | string | No | Search results configuration |
| `category_footer` | string | No | HTML/text content for the category footer |
| `category_header` | string | No | HTML/text content for the category header |
| `comments_header` | string | No | Header text for comments section |
| `distance_search` | integer | No | Whether distance-based search is enabled (1 for yes, 0 for no) |
| `profile_sidebar` | string | No | Sidebar configuration for profile pages |
| `category_sidebar` | string | No | Sidebar configuration for category pages |
| `profile_order_by` | string | No | Default sorting order for profile listings |
| `profile_per_page` | integer | No | Number of items per page in profile view |
| `software_version` | integer | No | Software version number |
| `category_order_by` | string | No | Default sorting order for category listings (e.g., 'publish-desc', 'title-asc') |
| `feature_categories` | string | No | Comma-separated list of featured categories |
| `revision_timestamp` | string | No | Timestamp for the last revision (format: YYYY-MM-DD HH:MM:SS) |
| `search_results_div` | string | No | HTML div configuration for search results |
| `profile_display_order` | integer | No | Display order in user profiles |
| `search_results_layout` | string | No | Layout template for search results |
| `sidebar_search_module` | string | No | Search module configuration for sidebar |
| `profile_results_layout` | string | No | Layout template for profile results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Post

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_DATA_POST`

Tool to create a new Single Image Post (member post) in the Brilliant Directories database. Use when adding blog posts, articles, or other content types with images to the website. Required fields: post_title, post_content, user_id, data_id, data_type, and post_status. Optional fields include author info, categories, tags, dates, geolocation, and image settings. The API uses application/x-www-form-urlencoded content type for the request body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude coordinate for geolocation |
| `lon` | number | No | Longitude coordinate for geolocation |
| `data_id` | integer | Yes | The data category ID for this post |
| `user_id` | integer | Yes | The ID of the user who owns this post |
| `state_sn` | string | No | State short name/code (e.g., CA) |
| `data_type` | integer | Yes | The type of post (e.g., 20 for Single Image Post) |
| `post_tags` | string | No | Comma-separated list of tags for the post |
| `post_type` | string | No | Type classification for the post |
| `country_sn` | string | No | Country short name/code (e.g., US) |
| `post_image` | string | No | Image URL or path for the post |
| `post_title` | string | Yes | The title of the post |
| `post_token` | string | No | Security token for the post |
| `post_author` | string | No | Author name for the post |
| `post_clicks` | integer | No | Number of clicks/views for the post |
| `post_status` | integer | Yes | The status of the post (0: inactive, 1: active/published) |
| `sticky_post` | integer | No | Whether the post is sticky/pinned (0: no, 1: yes) |
| `auto_geocode` | string ("disabled" | "enabled") | No | Auto geocode option for data posts. |
| `post_content` | string | Yes | HTML content of the post |
| `post_category` | string | No | Category name for the post |
| `post_filename` | string | No | URL-friendly filename/slug for the post |
| `image_imported` | integer | No | Whether image has been imported (0: no, 1: yes) |
| `post_live_date` | string | No | Date when post goes live in format YYYYMMDDHHMMSS |
| `recurring_type` | integer | No | Recurring event type (0: not recurring) |
| `revision_count` | integer | No | Number of revisions for the post |
| `post_start_date` | string | No | Start date for the post in format YYYYMMDDHHMMSS |
| `post_expire_date` | string | No | Expiration date for the post in format YYYYMMDDHHMMSS |
| `auto_image_import` | string ("disabled" | "enabled") | No | Auto image import option for data posts. |
| `original_image_url` | string | No | Original URL of the image to be imported |
| `revision_timestamp` | string | No | Timestamp of last revision in format YYYYMMDDHHMMSS |
| `sticky_post_expiration_date` | string | No | Expiration date for sticky post in format YYYY-MM-DD HH:MM:SS |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lead

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_LEAD`

Tool to create a new lead in the Brilliant Directories database. Use when adding new inquiries or contact requests from visitors. Supports automatic geocoding, member matching, and email notifications. Can specify categories, location data, pricing, and custom notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | The latitude coordinate for the lead location |
| `lng` | number | No | The longitude coordinate for the lead location |
| `nelat` | number | No | The northeast latitude boundary |
| `nelng` | number | No | The northeast longitude boundary |
| `swlat` | number | No | The southwest latitude boundary |
| `swlng` | number | No | The southwest longitude boundary |
| `status` | integer | No | The status of the lead (numeric status code) |
| `sub_id` | integer | No | The sub-category ID to associate with this lead |
| `top_id` | integer | No | The top-level category ID to associate with this lead |
| `lead_id` | integer | No | The lead ID (typically only used for updates, not creation) |
| `formname` | string | No | The name of the form used to submit the lead |
| `url_from` | string | No | The URL/page from which the lead was submitted |
| `lead_name` | string | No | The name of the lead/contact person |
| `origin_ip` | string | No | The IP address of the lead submitter |
| `auto_match` | string ("disabled" | "enabled") | No | Whether to automatically match this lead with members (0 = disabled, 1 = enabled) |
| `country_sn` | string | No | The country code (ISO 2-letter code) |
| `date_added` | string | No | The date the lead was added in YYYYMMDDHHMMSS format |
| `lead_email` | string | No | The email address of the lead |
| `lead_notes` | string | No | Admin notes about the lead (not visible to the lead) |
| `lead_phone` | string | No | The phone number of the lead |
| `lead_price` | number | No | The price to charge members to view this lead |
| `sub_sub_id` | integer | No | The sub-sub-category ID to associate with this lead |
| `flow_source` | string | No | The flow source identifier for tracking |
| `adm_lvl_1_sn` | string | No | The state/province code (administrative level 1) |
| `auto_geocode` | string ("disabled" | "enabled") | No | Whether to automatically geocode the lead location (0 = disabled, 1 = enabled) |
| `lead_message` | string | No | The message or inquiry from the lead |
| `lead_location` | string | No | The location description for the lead |
| `location_type` | string | No | The type of location (e.g., country, city, region) |
| `users_to_match` | string | No | ADVANCED: Comma-separated list of member email addresses or user IDs to directly match with this lead. Bypasses the normal auto-match system. Example: user1@example.com,user2@example.com or 123,456 |
| `sub_category_name` | string | No | The name of the sub-category |
| `top_category_name` | string | No | The name of the top-level category |
| `revision_timestamp` | string | No | The revision timestamp in YYYYMMDDHHMMSS format |
| `sub_sub_category_name` | string | No | The name of the sub-sub-category |
| `send_lead_email_notification` | string ("disabled" | "enabled") | No | Whether to send email notification to matched members (0 = disabled, 1 = enabled) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Portfolio Group

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_PORTFOLIO_GROUP`

Creates a new multi-image portfolio post in the Brilliant Directories database. This action allows users to publish content with multiple images, descriptions, and metadata such as categories, tags, and location information. Required fields: user_id (existing user), data_type (use 4 for multi-image posts), data_id (data record identifier), and group_name (post title). Optional fields include: content (group_desc), publication status (group_status), category, location, display order, image URLs with titles and descriptions, tags, geographic data, property details for real estate, and sticky post settings. Use this action when creating portfolio posts, blog articles with galleries, or any content requiring multiple images with rich metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_id` | integer | Yes | The data ID associated with this post. This links the post to specific data records. |
| `user_id` | integer | Yes | The ID of the user who owns this portfolio post. Must be an existing user ID in the system. |
| `state_sn` | string | No | State short name/code (e.g., CA, NY, TX). |
| `data_type` | integer | Yes | The data type identifier for the post. Use 4 for multi-image posts. |
| `post_tags` | string | No | Comma-separated list of tags for the post. Used for search and categorization. |
| `country_sn` | string | No | Country short name/code (e.g., US, CA, UK). |
| `group_desc` | string | No | HTML-formatted description or content of the post. Can include rich text formatting, links, and media. |
| `group_name` | string | Yes | The title/name of the multi-image post. This will be displayed as the main heading. |
| `post_image` | string | No | Comma-separated list of image filenames or URLs to include in the post. |
| `group_order` | integer | No | Display order for the post. Lower numbers appear first. Defaults to 0. |
| `group_token` | string | No | Authentication token for the post. |
| `sticky_post` | string ("no" | "yes") | No | Whether this post should be pinned/sticky. |
| `auto_geocode` | string ("disabled" | "enabled") | No | Auto-geocode status for location data. |
| `date_updated` | string | No | Last update timestamp in format YYYYMMDDHHMMSS (e.g., 20220714122910). |
| `group_status` | integer | No | Publication status of the post. Use 1 for published/active, 0 for draft/inactive. |
| `property_beds` | integer | No | Number of bedrooms (for real estate posts). |
| `property_type` | integer | No | Property type identifier (for real estate posts). |
| `group_category` | string | No | Category name for organizing the post. Used for filtering and organization. |
| `group_filename` | string | No | URL-friendly filename/slug for the post. |
| `group_location` | string | No | Location associated with the post in HTML format. Example: 'USA California, CA' |
| `property_baths` | integer | No | Number of bathrooms (for real estate posts). |
| `property_price` | integer | No | Property price (for real estate posts). |
| `revision_count` | integer | No | Number of revisions made to this post. |
| `property_status` | integer | No | Property status identifier (for real estate posts). |
| `post_image_title` | string | No | Comma-separated list of titles for each image. Must match the order of post_image. |
| `auto_image_import` | string ("disabled" | "enabled") | No | Auto-import images from external sources. |
| `property_sqr_foot` | integer | No | Property square footage (for real estate posts). |
| `post_image_description` | string | No | Comma-separated list of descriptions for each image. Must match the order of post_image. |
| `sticky_post_expiration_date` | string | No | Expiration date for sticky post in format YYYY-MM-DD HH:MM:SS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Unsubscribe

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_UNSUBSCRIBE`

Tool to add an unsubscriber to the database and unsubscribe a member from email campaigns. Use when you need to remove a member's email address from the email campaign list. Requires email address, code (source of unsubscribe), type ('unsubscribe'), and website_id. Optional parameters include date (timestamp), definitive flag (permanent unsubscribe), and id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Optional primary key ID for the unsubscribe record. Usually auto-generated if not provided. |
| `code` | string ("admin" | "email" | "api") | Yes | Source/method of the unsubscribe action. Use 'api' for API-initiated unsubscribes, 'admin' for admin panel unsubscribes, or 'email' for email link unsubscribes. |
| `date` | integer | No | Optional timestamp for the unsubscribe date in format YYYYMMDDHHMMSS (e.g., 20241010183414). If not provided, the current timestamp will be used. |
| `type` | string | Yes | Type of unsubscribe action. Use 'unsubscribe' to remove from email campaigns. |
| `email` | string | Yes | The email address to unsubscribe from email campaigns. Must be a valid email format. |
| `definitive` | integer | No | Optional flag indicating if the unsubscribe is definitive/permanent. 0 for temporary, 1 for permanent. |
| `website_id` | integer | Yes | The website/directory ID where the unsubscribe should be applied. Typically 1 for the primary website. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_USER`

Creates a new user/member account in the Brilliant Directories website database. Required fields: email, password (minimum 6 characters), and subscription_id (must reference an existing membership plan in the system). Optional fields include: personal information (first_name, last_name, company, position), contact details (phone_number, website), address fields (address1, address2, city, state_code, zip_code, country_code), profile information (about_me), and account status flags (active, verified). Returns complete user data including the generated user_id, authentication token, and assigned membership plan details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City name |
| `email` | string | Yes | The user's email address |
| `active` | integer | No | Account status (0: inactive, 1: active) |
| `company` | string | No | Company name |
| `website` | string | No | User's website URL |
| `about_me` | string | No | User description |
| `address1` | string | No | Primary address |
| `address2` | string | No | Secondary address |
| `password` | string | Yes | The user's password (minimum 6 characters) |
| `position` | string | No | Job position |
| `verified` | integer | No | Verification status (0: unverified, 1: verified) |
| `zip_code` | string | No | ZIP/Postal code |
| `last_name` | string | No | User's last name |
| `first_name` | string | No | User's first name |
| `state_code` | string | No | State code (e.g., CA) |
| `country_code` | string | No | Country code (e.g., US) |
| `phone_number` | string | No | Contact phone number |
| `subscription_id` | integer | Yes | The ID of the membership plan to assign the user to. Must be an existing membership plan ID in the system (e.g., 1 for free plan, 2 for paid plan) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Users Click

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_USERS_CLICK`

Tool to add a new user clicked link tracking record to the database. Creates a click tracking entry that records when and where users click on links within the directory. Required fields: click_url, click_name, click_type, user_id, date_clicked (format: YYYYMMDDHHmmss), and click_from (source page where click originated). Optional fields include click tracking details (click_ip, click_token, visitor_token) and post association fields (is_single_post, post_id). Note: The click_url must be a valid HTTP/HTTPS URL. Protocol schemes like tel: or mailto: are not supported by the API. Use this when you need to track user engagement with links in profiles, listings, or other directory pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | integer | No | ID of the post associated with the click (if applicable) |
| `user_id` | integer | Yes | The ID of the user who clicked the link |
| `click_id` | integer | No | Primary key identifier for the click record (used for updates) |
| `click_ip` | string | No | IP address of the user who clicked the link |
| `click_url` | string | Yes | The URL that was clicked by the user |
| `click_from` | string | Yes | Source page or location where the click originated (e.g., 'profile_page', 'listing_page', 'search_results') |
| `click_name` | string | Yes | Display name or label for the clicked link |
| `click_type` | string | Yes | Type of link that was clicked (e.g., 'link', 'email', 'phone') |
| `click_token` | string | No | Unique token identifier for the click event |
| `date_clicked` | string | Yes | Timestamp when the link was clicked in format YYYYMMDDHHmmss (e.g., 20240213120000 for February 13, 2024 at 12:00:00) |
| `visitor_token` | string | No | Token identifying the visitor who clicked the link |
| `is_single_post` | integer | No | Flag indicating if the click is from a single post (0 = No, 1 = Yes) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Widget

**Slug:** `BRILLIANT_DIRECTORIES_CREATE_WIDGET`

Tool to create a new widget in the Brilliant Directories website database. Use when you need to add custom HTML/PHP content, CSS styles, or JavaScript to create a reusable widget component.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widget_data` | string | No | The HTML/PHP content/data for the widget |
| `widget_name` | string | Yes | The name/title of the widget to create |
| `widget_style` | string | No | CSS styles for the widget |
| `widget_javascript` | string | No | JavaScript code for the widget |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Album Photo

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_ALBUM_PHOTO`

Tool to delete an album photo and its related data from the database. Use when you need to permanently remove a photo from a user's portfolio album.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_id` | integer | Yes | The photo_id of the users_portfolio (Primary Key) to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Data Category

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_DATA_CATEGORY`

Tool to permanently delete a post type (data category) and all related data from the database. Use when you need to completely remove a post type such as Videos, Articles, Jobs, Events, Coupons, Audios, or Discussions. This is a destructive operation that cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_id` | integer | Yes | The data_id of the data_categories (Primary Key) to permanently delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Lead

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_LEAD`

Tool to delete a lead and their related data from the database. Use when you need to permanently remove a lead record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | integer | Yes | The lead_id of the leads (Primary Key). The unique identifier of the lead to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Portfolio Group

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_PORTFOLIO_GROUP`

Tool to delete a multi-image post (portfolio group) and its related data from the database. Use when you need to permanently remove a portfolio group/multi-image post.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | The group_id of the users_portfolio_groups (Primary Key) to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Unsubscribe Record

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_UNSUBSCRIBE`

Tool to delete an unsubscribe record and its related data from the database. Use when you need to remove an email from the unsubscribe list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the unsubscribe_list record to delete (Primary Key) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_USER`

This tool deletes an existing user record from the Brilliant Directories website database. It allows for the complete removal of a user record and, optionally, the deletion of the member's uploaded images.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique identifier of the user to be deleted |
| `delete_images` | integer | No | Whether to delete the user's uploaded images (0 = No, 1 = Yes) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Users Click

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_USERS_CLICK`

Tool to delete a user clicked link and their related data from the database. Permanently removes a click record identified by click_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `click_id` | integer | Yes | The click_id of the users_clicks record to delete (Primary Key) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Widget

**Slug:** `BRILLIANT_DIRECTORIES_DELETE_WIDGET`

Tool to delete a widget and its related data from the database. Use when you need to permanently remove a widget. This is a destructive operation that cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widget_id` | integer | Yes | The widget_id of the data_widgets (Primary Key). This is the unique identifier of the widget to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Album Photo

**Slug:** `BRILLIANT_DIRECTORIES_GET_ALBUM_PHOTO`

Retrieves the complete metadata and details for a single album image from Brilliant Directories. This action fetches comprehensive information about an album photo including its title, description, file paths, timestamps, status, and other metadata. Use when you need to read the data of a specific album image based on its photo_id. Use cases: - Retrieve metadata for a specific photo - Access photo URLs and file paths - Check photo status and visibility settings - Get photo details for display or editing

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_id` | string | Yes | The photo_id of the users_portfolio (Primary Key). This is the unique identifier for the album image. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Categories Fields

**Slug:** `BRILLIANT_DIRECTORIES_GET_DATA_CATEGORIES`

This tool retrieves all available custom fields for Data Categories (Post Types) in a Brilliant Directories website. Data categories/post types include content types like Videos, Articles, Jobs, Events, Coupons, Audios, and Discussions. The endpoint returns field metadata including field keys, labels, types, whether they're required, and help text. This information is useful for understanding what fields are available when working with post types.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Category

**Slug:** `BRILLIANT_DIRECTORIES_GET_DATA_CATEGORY`

Tool to retrieve configuration data for a single post type (data category) in Brilliant Directories. Post types include content types like Videos, Articles, Jobs, Events, Coupons, Audios, and Discussions. This action returns the complete configuration and settings for the specified post type based on its data_id. Use this when you need to inspect or retrieve settings for a specific post type rather than listing all available post types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_id` | string | Yes | The data_id of the data category (post type). This is the primary key identifier for the post type (e.g., '1', '2', '3'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Post

**Slug:** `BRILLIANT_DIRECTORIES_GET_DATA_POST`

Tool to retrieve a single image/video post from the Brilliant Directories member posts system. Use this action when you need to read the complete data and metadata for a specific post based on its post_id. Returns detailed post information including content, author details, category information, and associated user data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | The unique identifier (Primary Key) of the data post to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead

**Slug:** `BRILLIANT_DIRECTORIES_GET_LEAD`

Tool to retrieve a single lead's complete information from Brilliant Directories. Use when you need to fetch detailed data about a specific lead by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | string | Yes | The lead_id of the lead to retrieve (Primary Key) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead Fields

**Slug:** `BRILLIANT_DIRECTORIES_GET_LEAD_FIELDS`

This tool retrieves all available fields in the leads table from a Brilliant Directories website. It returns a JSON object containing a list of fields and their associated metadata (field name, field type, field label, whether the field is required, and if it is a system field) that can be used to understand the structure and metadata of lead-related fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Portfolio Group

**Slug:** `BRILLIANT_DIRECTORIES_GET_PORTFOLIO_GROUP`

Tool to retrieve multi-image post data by group_id. Use when you need to fetch content and metadata for a specific portfolio group or multi-image post. Returns comprehensive information including images, descriptions, location, tags, and property details if applicable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The unique identifier (primary key) of the users_portfolio_groups record to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review

**Slug:** `BRILLIANT_DIRECTORIES_GET_REVIEW`

Tool to retrieve complete review data from Brilliant Directories based on review_id. Use when you need to read full review details including content, ratings, reviewer info, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `review_id` | string | Yes | The review_id of the users_reviews (Primary Key) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reviews Fields

**Slug:** `BRILLIANT_DIRECTORIES_GET_REVIEWS_FIELDS`

Get metadata about all available fields in the users_reviews table from a Brilliant Directories website. This tool returns comprehensive field definitions for the reviews system, including: - Core review fields (review_id, review_title, review_description, review_status) - Reviewer information fields (review_name, review_email) - Rating fields (rating_overall, rating_service, rating_response, rating_expertise, rating_results, rating_language) - Timestamp fields (review_added, review_updated, review_approved) - Technical fields (review_token, ip, httpr, formname, revision_timestamp) - Media fields (review_images) - Association fields (user_id, member_id, service_id) This is a read-only tool that requires only authentication and does not make API calls. It provides the standard field schema based on Brilliant Directories API documentation, useful for understanding what fields are available when creating, updating, or searching for reviews.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unsubscribe Record

**Slug:** `BRILLIANT_DIRECTORIES_GET_UNSUBSCRIBE`

Tool to retrieve a single unsubscriber record by ID. Use when you need to get details about a specific unsubscribe entry, including the email address, unsubscribe date, and source (admin, email link, or API).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the unsubscribe record (Primary Key). This is the unique identifier for the unsubscribe list entry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User by ID

**Slug:** `BRILLIANT_DIRECTORIES_GET_USER`

Tool to retrieve comprehensive data for a single user by their user_id. Use when you need to fetch complete user profile information including contact details, subscription data, and membership information. This action queries the Brilliant Directories API using the user_id as a path parameter, returning detailed user information including profile data, contact details, subscription information, social media links, and more.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The user_id of the user (Primary Key). This is the unique identifier for the user in the database. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Data

**Slug:** `BRILLIANT_DIRECTORIES_GET_USER_FIELDS`

Retrieves comprehensive user data from the Brilliant Directories database by searching for a specific property value. This action queries the users_data table using a property (column name) and value pair, returning detailed user information including profile data, contact details, subscription information, social media links, and more. Commonly used to fetch user records by user_id, email, or any other database column. Use cases: - Look up a user by their ID or email - Retrieve complete user profile information - Access subscription and membership details - Get contact information and social media links

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `property` | string | No | The database column name to search by. Common options include 'user_id', 'email', 'company', 'phone_number', etc. Any column from the users_data table can be used. |
| `property_value` | string | Yes | The value to search for in the specified property/column. This should match the expected data type of the column (e.g., numeric string for user_id, email format for email). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Clicked Link

**Slug:** `BRILLIANT_DIRECTORIES_GET_USERS_CLICK`

Tool to retrieve click tracking data for a single user clicked link based on the click_id. Use when you need to fetch detailed information about a specific click event, including the user who clicked, the click type, source and destination URLs, timestamps, and associated tokens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `click_id` | string | Yes | The unique identifier of the click record to retrieve. This is the Primary Key of the users_clicks table. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Transactions

**Slug:** `BRILLIANT_DIRECTORIES_GET_USER_TRANSACTIONS`

Retrieves payment and transaction history for a member in Brilliant Directories. This action queries transaction records using either user_id or client_id, returning detailed payment history including transaction amounts, dates, payment methods, and status. Optionally returns user schema and credit card information when return_schema is set to 'yes'. Use cases: - Retrieve all transactions for a specific user - Access payment history and invoice details - Get credit card information on file - View transaction status and payment methods

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | The user_id of the user (Primary Key). Use this to retrieve transactions for a specific user. Both user_id and client_id are required by the API. |
| `client_id` | integer | Yes | The id of the tblclients (Primary Key). Use this to retrieve transactions for a specific client. Both user_id and client_id are required by the API. Typically matches the user_id. |
| `return_schema` | string ("no" | "yes") | No | Enum for return_schema parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Widget

**Slug:** `BRILLIANT_DIRECTORIES_GET_WIDGET`

Retrieves the data of a single widget based on the widget_id. Use this to fetch widget configuration and settings from the Brilliant Directories website database.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widget_id` | string | Yes | The widget_id of the data_widgets (Primary Key). Use this to retrieve specific widget configuration and settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Match Leads

**Slug:** `BRILLIANT_DIRECTORIES_MATCH_LEADS`

Tool to match a batch of emails or user IDs to a specific lead record. Use this when you need to associate multiple contacts or users with an existing lead in the Brilliant Directories system. The users_to_match parameter accepts a comma-separated list of either email addresses or user IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | integer | Yes | The unique identifier of the lead to match users to. Must be an existing lead ID in the system |
| `users_to_match` | string | Yes | Comma-separated list of user emails or user IDs to associate with the lead. For example: 'user1@example.com,user2@example.com' or '123,456,789' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Reviews

**Slug:** `BRILLIANT_DIRECTORIES_SEARCH_REVIEWS`

Search reviews and their related data from the database. Filter reviews by various criteria. Supports filtering by location (address), keyword search (q), overall rating, and pagination (page, limit). Results can be ordered by date (ascending/descending) or randomly. Use output_type to specify response format (html or array). Enable caching with post_type_cache_system for faster subsequent searches. Use search_priority_flag to prioritize results by membership plan settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Enter a keyword to search for in review data |
| `page` | integer | No | Enter the page number of results to return. For example, enter 2 to return the second page of results |
| `limit` | integer | No | Enter the maximum number of review results to return per page of results |
| `address` | string | No | Enter the location to search for. Example: Los Angeles, California, United States |
| `output_type` | string ("html" | "array") | No | Output type options for response format. |
| `overall_rating` | integer | No | Set from 0 to 5 to filter the review by overall rating |
| `category_order_by` | string ("date-asc" | "date-desc" | "random") | No | Order by options for search results. |
| `search_priority_flag` | integer | No | Set to 1 to first be ordered by the search priority defined in membership plan settings, and then by the Order Results By setting. Set to 0 to skip search priority ordering |
| `post_type_cache_system` | integer | No | Set to 1 (recommended) to cache search results and load subsequent matching search results more quickly. Set to 0 to always query the database for all searches. This cannot be enabled if Order Results By is set to Random |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Users

**Slug:** `BRILLIANT_DIRECTORIES_SEARCH_USERS`

Search for users/members in the Brilliant Directories database with advanced filtering options. Allows searching and filtering members by keywords, location, categories, and other criteria. Supports pagination, multiple sort orders, and dynamic category filtering for complex queries. Returns comprehensive user data including profile information, contact details, subscription status, and related metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Keyword to search for in member data. Searches across multiple user fields like name, company, description, etc. |
| `pid` | integer | No | Top Level Category ID to filter members. When dynamic filter is enabled (dynamic=1), provide a comma-separated list of IDs in a single integer or string format. |
| `tid` | integer | No | Sub Level Category ID to filter members. When dynamic filter is enabled (dynamic=1), provide a comma-separated list of IDs. |
| `page` | integer | No | Page number of results to return. For example, enter 2 to return the second page of results. Use in combination with 'limit' parameter for pagination. |
| `sort` | string ("reviews" | "name ASC" | "name DESC" | "last_name_asc" | "last_name_desc") | No | Enum for sort order options. |
| `ttid` | integer | No | Sub-Sub Level Category ID to filter members. When dynamic filter is enabled (dynamic=1), provide a comma-separated list of IDs. |
| `limit` | integer | No | Maximum number of search results to return per page. Controls pagination size. |
| `address` | string | No | Location to search for. Use full address format (e.g., 'Los Angeles, California, United States') |
| `dynamic` | integer ("0" | "1") | No | Enum for dynamic category filter options. |
| `output_type` | string ("html" | "array") | No | Enum for output type options. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Album Photo

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_ALBUM_PHOTO`

Updates an existing album photo record in the Brilliant Directories database. Modifies photo metadata such as title, description, keywords, and status. The photo_id is required to identify which photo to update. All other fields are optional and only the provided fields will be updated. Use when you need to modify photo information, update visibility status, change organization (order, group), or edit photo metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `desc` | string | No | Description of the photo with details about the image content |
| `file` | string | No | Path to the full-size image file |
| `link` | string | No | External link or URL associated with the photo |
| `order` | integer | No | Display order of the photo within its group/album |
| `price` | number | No | Price associated with the photo if it's available for purchase |
| `title` | string | No | The title or name of the photo |
| `inv_id` | string | No | Inventory ID for product tracking |
| `status` | integer ("0" | "1") | No | Status of the album photo. |
| `data_id` | integer | No | The ID of the associated data record |
| `orgfile` | string | No | Original filename of the uploaded image |
| `room_id` | integer | No | The ID of the room this photo is associated with |
| `user_id` | integer | No | The ID of the user who owns this photo |
| `group_id` | integer | No | The ID of the group/album this photo belongs to |
| `keywords` | string | No | Comma-separated keywords or tags for the photo to improve searchability |
| `photo_id` | integer | Yes | The unique identifier of the album photo to update. This is required to specify which photo record should be modified. |
| `condition` | string | No | Condition of the item in the photo (for product photos) |
| `data_type` | integer | No | The type of data this photo is associated with |
| `thumbnail` | string | No | Path to the thumbnail version of the image |
| `group_cover` | integer ("0" | "1") | No | Whether photo is used as group cover. |
| `photo_token` | string | No | Unique token identifier for the photo |
| `availability` | string | No | Availability status of the photo |
| `manufacturer` | string | No | Manufacturer name (for product photos) |
| `product_type` | string | No | Type of product shown in the photo |
| `image_imported` | string ("0" | "1" | "2") | No | Image import status. |
| `photo_filename` | string | No | System-generated filename for the photo |
| `reason_inactive` | string | No | Reason why the photo is inactive (if status is 0) |
| `photo_date_added` | string | No | Timestamp when the photo was originally added (format: YYYYMMDDHHmmss) |
| `product_category` | string | No | Category of product shown in the photo |
| `additional_fields` | string | No | JSON string containing additional custom fields for the photo |
| `facebook_photo_id` | string | No | Facebook photo ID if imported from Facebook |
| `original_image_url` | string | No | URL of the original image if imported from external source |
| `photo_date_updated` | string | No | Timestamp when the photo was last updated (format: YYYYMMDDHHmmss) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Data Category

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_DATA_CATEGORY`

Tool to update an existing post type (data category) record in Brilliant Directories. Use when you need to modify post type settings such as name, display options, layout templates, pagination settings, or other configuration parameters. Requires the data_id parameter to identify which post type to update. All other parameters are optional and only the provided fields will be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `h1` | string | No | The H1 heading text for the category page |
| `h2` | string | No | The H2 heading text for the category page |
| `icon` | string | No | The icon HTML/CSS for the category |
| `data_id` | integer | Yes | The unique identifier of the data category (post type) to update |
| `comments` | string | No | Whether comments are enabled (0 = no, 1 = yes) |
| `per_page` | integer | No | Number of items to display per page in category view |
| `always_on` | integer | No | Whether the category is always visible (0 = no, 1 = yes) |
| `data_name` | string | No | The name of the data category (e.g., 'Classified', 'Article') |
| `data_type` | integer | No | The type identifier for the data category |
| `form_name` | string | No | The name of the form associated with this data category |
| `post_date` | string | No | Default post date configuration |
| `post_type` | string | No | Post type configuration |
| `data_active` | string | No | Whether the data category is active (0 = inactive, 1 = active) |
| `profile_tab` | string | No | The tab name on profile pages |
| `system_name` | string | No | The system name identifier for the data category |
| `category_sql` | string | No | Custom SQL query for the category |
| `category_tab` | string | No | The tab name for the category |
| `comments_code` | string | No | Custom code for comments integration |
| `data_filename` | string | No | The filename identifier for the data category |
| `display_order` | integer | No | The display order/position of this category |
| `caption_length` | integer | No | Maximum length of captions/excerpts |
| `category_group` | integer | No | The group identifier for this category |
| `footer_content` | string | No | Additional footer content |
| `profile_footer` | string | No | Footer content for profile pages |
| `profile_header` | string | No | Header content for profile pages |
| `search_results` | string | No | Search results configuration |
| `category_footer` | string | No | Footer content for the category page |
| `category_header` | string | No | Header content for the category page |
| `comments_header` | string | No | Header content for comments section |
| `distance_search` | integer | No | Whether distance-based search is enabled (0 = no, 1 = yes) |
| `profile_sidebar` | string | No | Sidebar template for profile pages |
| `category_sidebar` | string | No | Sidebar template for category pages |
| `profile_order_by` | string | No | Default ordering for profile results |
| `profile_per_page` | integer | No | Number of items to display per page in profile view |
| `software_version` | integer | No | The software version identifier |
| `category_order_by` | string | No | Default ordering for category results |
| `feature_categories` | string | No | Comma-separated list of featured categories |
| `revision_timestamp` | string | No | The revision timestamp in format YYYY-MM-DD HH:MM:SS |
| `search_results_div` | string | No | Search results div configuration |
| `profile_display_order` | integer | No | The display order on profile pages |
| `search_results_layout` | string | No | The layout template for search results |
| `sidebar_search_module` | string | No | The search module template for the sidebar |
| `profile_results_layout` | string | No | The layout template for profile results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Data Post

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_DATA_POST`

Updates a single image post record and related data in the Brilliant Directories database. Use this action to modify existing post content including title, content, status, metadata, and other post-related fields. The post_id is required to identify which post to update. All other fields are optional - only the fields you provide will be updated. This allows for partial updates of post records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude coordinate for the post location. |
| `lon` | number | No | Longitude coordinate for the post location. |
| `data_id` | integer | No | Data identifier for the post. |
| `post_id` | integer | Yes | The unique identifier of the post to update. This is the primary key of the post record. |
| `user_id` | integer | No | The ID of the user associated with the post. |
| `state_sn` | string | No | State short name/code (e.g., CA, NY). |
| `data_type` | integer | No | Type identifier for the data. |
| `post_tags` | string | No | Comma-separated list of tags for the post. |
| `post_type` | string | No | Type of the post. |
| `country_sn` | string | No | Country short name/code (e.g., US, CA). |
| `post_image` | string | No | Image URL or path associated with the post. |
| `post_title` | string | No | The title of the post. |
| `post_token` | string | No | Security token for the post. |
| `post_author` | string | No | The author name of the post. |
| `post_clicks` | integer | No | Number of clicks on the post. |
| `post_status` | integer | No | Status of the post (0: inactive/draft, 1: active/published). |
| `sticky_post` | integer | No | Whether the post is pinned/sticky (0: no, 1: yes). |
| `auto_geocode` | integer | No | Whether to automatically geocode the location (0: no, 1: yes). |
| `post_content` | string | No | The main content of the post. Can include HTML formatting. |
| `post_category` | string | No | The category name for the post. |
| `post_filename` | string | No | URL-friendly slug/filename for the post. |
| `image_imported` | integer | No | Whether the image has been imported (0: no, 1: yes). |
| `post_live_date` | string | No | Live/publish date for the post in YYYYMMDDHHMMSS format. |
| `recurring_type` | integer | No | Recurring type indicator for the post. |
| `revision_count` | integer | No | Number of revisions made to the post. |
| `post_start_date` | string | No | Start date for the post in YYYYMMDDHHMMSS format. |
| `post_expire_date` | string | No | Expiration date for the post in YYYYMMDDHHMMSS format. |
| `auto_image_import` | integer | No | Whether to automatically import images (0: no, 1: yes). |
| `original_image_url` | string | No | URL of the original image before import. |
| `revision_timestamp` | string | No | Timestamp of the last revision in YYYYMMDDHHMMSS format. |
| `sticky_post_expiration_date` | string | No | Expiration date for sticky post status in datetime format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lead

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_LEAD`

Updates an existing lead record in the Brilliant Directories website database. The lead_id field is required to identify which lead to update. All other fields are optional - only provide the fields you want to update. This action modifies lead information including contact details (name, email, phone), inquiry details (message, notes, price), location data (coordinates, boundaries, location type), categorization (category IDs and names), and matching settings (auto-match, email notifications, direct member matching).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude coordinate for lead location |
| `lng` | number | No | Longitude coordinate for lead location |
| `nelat` | number | No | Northeast boundary latitude for lead service area |
| `nelng` | number | No | Northeast boundary longitude for lead service area |
| `swlat` | number | No | Southwest boundary latitude for lead service area |
| `swlng` | number | No | Southwest boundary longitude for lead service area |
| `status` | integer | No | Lead status code |
| `sub_id` | integer | No | Sub-category ID for the lead |
| `top_id` | integer | No | Top-level category ID for the lead |
| `lead_id` | integer | Yes | The unique identifier of the lead to update (required) |
| `formname` | string | No | Name of the form used to capture this lead |
| `url_from` | string | No | URL from which the lead was submitted |
| `lead_name` | string | No | Full name of the lead contact person |
| `origin_ip` | string | No | IP address from which the lead was submitted |
| `auto_match` | string ("disabled" | "enabled") | No | Auto-match option for connecting leads to members |
| `country_sn` | string | No | Country short name code (e.g., US, CA, GB) |
| `date_added` | string | No | Date when the lead was added (format: YYYYMMDDHHmmss) |
| `lead_email` | string | No | Email address of the lead |
| `lead_notes` | string | No | Admin notes about this lead (internal use) |
| `lead_phone` | string | No | Phone number of the lead |
| `lead_price` | number | No | Price associated with this lead (if charging for lead access) |
| `sub_sub_id` | integer | No | Sub-sub-category ID for the lead |
| `flow_source` | string | No | Source flow identifier for tracking lead origin |
| `adm_lvl_1_sn` | string | No | State or province short name code |
| `auto_geocode` | string ("disabled" | "enabled") | No | Auto-geocode option for lead location |
| `lead_message` | string | No | Message or inquiry from the lead |
| `lead_location` | string | No | Location description for the lead |
| `location_type` | string | No | Type of location (e.g., country, state, city) |
| `users_to_match` | string | No | ADVANCED: Comma-separated list of member email addresses or user IDs to directly match with this lead. When provided, this bypasses the normal auto-match system |
| `sub_category_name` | string | No | Name of the sub-category |
| `top_category_name` | string | No | Name of the top-level category |
| `revision_timestamp` | string | No | Timestamp of the last revision (format: YYYYMMDDHHmmss) |
| `sub_sub_category_name` | string | No | Name of the sub-sub-category |
| `send_lead_email_notification` | string ("disabled" | "enabled") | No | Send email notification option |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Portfolio Group

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_PORTFOLIO_GROUP`

Tool to update a multi-image post (portfolio group) record in the Brilliant Directories database. Use when you need to modify existing portfolio content, change post details, update images, or modify property information for real estate listings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_id` | integer | No | Data ID associated with the portfolio group |
| `user_id` | integer | No | ID of the user who owns this portfolio group |
| `group_id` | integer | Yes | The unique identifier of the portfolio group to update (primary key) |
| `state_sn` | string | No | State short name code (e.g., CA, NY, TX) |
| `data_type` | integer | No | Data type identifier for the portfolio group |
| `post_tags` | string | No | Comma-separated list of tags for the post |
| `country_sn` | string | No | Country short name code (e.g., US, CA, UK) |
| `group_desc` | string | No | HTML description/content of the portfolio group |
| `group_name` | string | No | Name/title of the portfolio group or multi-image post |
| `post_image` | string | No | Comma-separated list of image filenames for the post |
| `group_order` | integer | No | Display order for the portfolio group |
| `group_token` | string | No | Unique token for the portfolio group |
| `sticky_post` | integer | No | Whether the post should be sticky/pinned (0 = no, 1 = yes) |
| `auto_geocode` | string ("disabled" | "enabled") | No | Whether to automatically geocode location data |
| `date_updated` | string | No | Update timestamp in format YYYYMMDDHHMMSS |
| `group_status` | integer | No | Status of the portfolio group (0 = inactive, 1 = active) |
| `property_beds` | integer | No | Number of bedrooms (for real estate listings) |
| `property_type` | integer | No | Property type identifier (for real estate listings) |
| `group_category` | string | No | Category name for the portfolio group |
| `group_filename` | string | No | Filename associated with the portfolio group |
| `group_location` | string | No | Location information for the portfolio group (HTML format) |
| `property_baths` | integer | No | Number of bathrooms (for real estate listings) |
| `property_price` | integer | No | Property price (for real estate listings) |
| `revision_count` | integer | No | Number of revisions for this portfolio group |
| `property_status` | integer | No | Property status identifier (for real estate listings) |
| `post_image_title` | string | No | Comma-separated list of titles for each image in the post |
| `auto_image_import` | string ("disabled" | "enabled") | No | Whether to automatically import images |
| `property_sqr_foot` | integer | No | Property square footage (for real estate listings) |
| `post_image_description` | string | No | Comma-separated list of descriptions for each image in the post |
| `sticky_post_expiration_date` | string | No | Expiration date for sticky post in format YYYY-MM-DD HH:MM:SS |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Unsubscribe

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_UNSUBSCRIBE`

Updates an existing unsubscribe list record in the Brilliant Directories database. Use this to modify unsubscribe settings for email campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the unsubscribe list record to update |
| `code` | string ("admin" | "email" | "api") | Yes | The source code for the unsubscribe action. Indicates how the unsubscribe was initiated |
| `date` | integer | Yes | The date/time of the unsubscribe action in format YYYYMMDDHHmmss (e.g., 20260213130000 for 2026-02-13 13:00:00) |
| `type` | string | Yes | The type of the unsubscribe action |
| `email` | string | Yes | The email address to update in the unsubscribe list |
| `definitive` | integer | Yes | Whether the unsubscribe is definitive/permanent (0 = No, 1 = Yes) |
| `website_id` | integer | Yes | The ID of the website this unsubscribe record belongs to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_USER`

Updates an existing user record in the Brilliant Directories website database. Modifies user profile information, contact details, social media links, account status, membership plan, and other user-related data. Only user_id is required; all other fields are optional and will only update the specified fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cv` | string | No | Path or URL to the user's CV/resume file |
| `lat` | number | No | Latitude coordinate for geographic location |
| `lon` | number | No | Longitude coordinate for geographic location |
| `blog` | string | No | User's blog URL |
| `city` | string | No | City name |
| `logo` | string | No | Path or URL to the user's logo image |
| `email` | string | No | User's email address |
| `quote` | string | No | Personal quote or tagline |
| `active` | string ("active" | "pending_approval" | "suspended" | "pending_email_verification" | "deleted" | "rejected") | No | User account status codes. |
| `awards` | string | No | Awards and recognitions received |
| `company` | string | No | Company name |
| `modtime` | string | No | Modification timestamp in format YYYY-MM-DD HH:MM:SS |
| `twitter` | string | No | Twitter profile URL |
| `user_id` | integer | Yes | The unique identifier of the user to update. This is required. |
| `website` | string | No | User's website URL |
| `youtube` | string | No | YouTube channel URL |
| `about_me` | string | No | User's profile description or bio (supports HTML) |
| `address1` | string | No | Primary address line |
| `address2` | string | No | Secondary address line (apartment, suite, etc.) |
| `facebook` | string | No | Facebook profile URL |
| `featured` | integer | No | Whether the user is featured (0 = No, 1 = Yes) |
| `linkedin` | string | No | LinkedIn profile URL |
| `password` | string | No | New password for the user account |
| `position` | string | No | Job position or title |
| `services` | string | No | Services offered. Format: 'category=>service1,service2' |
| `snapchat` | string | No | Snapchat username or URL |
| `state_ln` | string | No | Full state or province name |
| `verified` | integer | No | Email verification status (0 = Unverified, 1 = Verified) |
| `whatsapp` | string | No | WhatsApp contact information |
| `zip_code` | string | No | ZIP or postal code |
| `google_id` | string | No | Google account ID |
| `instagram` | string | No | Instagram profile URL |
| `last_name` | string | No | User's last name |
| `pinterest` | string | No | Pinterest profile URL |
| `country_ln` | string | No | Full country name |
| `experience` | integer | No | Years of experience or starting year |
| `first_name` | string | No | User's first name |
| `last_login` | string | No | Last login timestamp in format YYYYMMDDHHMMSS |
| `nationwide` | integer | No | Whether the user operates nationwide (0 = No, 1 = Yes) |
| `state_code` | string | No | State or province code (e.g., CA for California) |
| `affiliation` | string | No | Professional affiliations or memberships |
| `cover_photo` | string | No | Path or URL to the user's cover photo |
| `credentials` | string | No | Professional credentials or qualifications |
| `facebook_id` | string | No | Facebook user ID |
| `member_tags` | string | No | Comma-separated list of member tag IDs to assign to the user |
| `rep_matters` | string | No | Additional representative information (e.g., business hours) |
| `signup_date` | string | No | User signup date in format YYYYMMDDHHMMSS |
| `auto_geocode` | string ("disabled" | "enabled") | No | Auto-geocode option for address. |
| `country_code` | string | No | Country code (e.g., US for United States) |
| `listing_type` | string | No | Type of listing (e.g., Individual, Business) |
| `phone_number` | string | No | Contact phone number |
| `credit_action` | string ("add" | "deduct" | "override") | No | Action to perform on user credits. |
| `credit_amount` | number | No | Amount of credits to add, deduct, or set (depending on credit_action) |
| `images_action` | string ("remove_all" | "remove_cover_image" | "remove_logo_image" | "remove_profile_image") | No | Action to perform on user images. |
| `profession_id` | integer | No | ID of the profession/category associated with the user |
| `profile_photo` | string | No | Path or URL to the user's profile photo |
| `subscription_id` | integer | No | ID of the membership plan assigned to the user |
| `auto_image_import` | string ("disabled" | "enabled") | No | Auto image import option. |
| `delete_categories` | string ("no" | "yes") | No | Whether to delete existing categories. |
| `member_tag_action` | string ("replace" | "append") | No | Action to perform on member tags. |
| `search_description` | string | No | Description that appears in search results |
| `create_new_categories` | string ("no" | "yes") | No | Whether to create new categories if they don't exist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Click Record

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_USERS_CLICK`

Updates a user clicked link record and their related data from the database. Modifies click tracking data for existing click records. This action is used to update click tracking information such as click names, URLs, timestamps, user associations, and other metadata for existing click records. The click_id is required to identify which record to update, and all other fields are optional - only provided fields will be updated. Use when you need to correct or update click tracking data, modify click metadata, or update user associations for click records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | integer | No | The ID of the post associated with the click, if applicable. Use 0 if not associated with a post. |
| `user_id` | integer | No | The ID of the user who clicked the link |
| `click_id` | integer | Yes | The unique identifier (primary key) of the click record to update. This is required to identify which click record should be modified. |
| `click_ip` | string | No | The IP address of the user who clicked the link |
| `click_url` | string | No | The URL that was clicked by the user |
| `click_from` | string | No | The source page or location where the click originated (e.g., 'profile_page', 'home_page') |
| `click_name` | string | No | The name or label for the clicked link (e.g., 'Website Link', 'Contact Button') |
| `click_type` | string | No | The type of click (e.g., 'link', 'button', 'banner') |
| `click_token` | string | No | A unique token associated with this specific click event |
| `date_clicked` | string | No | The timestamp when the link was clicked, in YYYYMMDDHHmmss format (e.g., '20260213130000' for 2026-02-13 13:00:00) |
| `visitor_token` | string | No | A unique token identifying the visitor who made the click |
| `is_single_post` | integer ("0" | "1") | No | Enum for is_single_post field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Widget

**Slug:** `BRILLIANT_DIRECTORIES_UPDATE_WIDGET`

Tool to update an existing widget record in the Brilliant Directories database. Modifies widget settings including name, HTML/PHP content, CSS styles, and JavaScript code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widget_id` | integer | Yes | The unique identifier of the widget to update. Must be an existing widget ID in the system |
| `widget_data` | string | No | The HTML/PHP content data of the widget |
| `widget_name` | string | No | The name of the widget |
| `widget_style` | string | No | The CSS style rules for the widget |
| `widget_javascript` | string | No | The JavaScript code for the widget |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |