# 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
- **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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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).

### 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.

### 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

### 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.

### 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

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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.

### 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).

### 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.

### 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.

### 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.

### 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.

### 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.
