Skip to main content
Brilliant Directories logo
  • Category: website builders
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 44
  • Triggers: 0
  • Slug: BRILLIANT_DIRECTORIES
  • Version: 20261101_00

Tools

Slug: BRILLIANT_DIRECTORIES_CREATE_ALBUM_PHOTOTool 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

string
Description of the album photo
string
Path to the full-size image file
External link URL associated with the photo
integer
Display order for sorting photos in the album
number
Price associated with the photo (for e-commerce functionality)
string
required
The title of the album photo
string
Inventory ID (for product photos)
integer
Status of the photo (0 = Inactive, 1 = Active)
integer
Associated data ID for the photo
string
Original filename of the uploaded image
integer
ID of the room this photo belongs to
integer
required
The ID of the user who owns the album. Required field.
integer
ID of the group this photo belongs to
string
Keywords associated with the photo for search and categorization
string
Condition description of the photo (for e-commerce functionality)
integer
Type of data associated with the photo
string
Path to the thumbnail image file
integer
Whether this photo is the group cover image (0 = No, 1 = Yes)
string
Unique token identifier for the photo
string
Availability status of the photo (for e-commerce functionality)
string
Manufacturer information (for product photos)
string
Type of product (for product photos)
string
Import status of the image (0 = Not imported, 1 = Basic import, 2 = Advanced import)
string
Filename for the photo stored in the system
string
Reason why the photo is inactive, if applicable
string
Date and time when the photo was added (format: YYYYMMDDHHMMSS)
string
Category of product (for product photos)
string
JSON string containing additional custom fields
string
Facebook photo ID if imported from Facebook
string
URL of the original image if imported from external source
string
Date and time when the photo was last updated (format: YYYYMMDDHHMMSS)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_DATA_CATEGORYCreates 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

string
H1 heading text for the post type page
string
H2 heading text for the post type page
string
Icon HTML/class for the post type (e.g., FontAwesome icon)
integer
Primary key identifier (typically auto-generated, leave empty for new records)
string
Whether comments are enabled (0 for disabled, 1 for enabled)
integer
Number of items to display per page in listings
integer
Whether the post type is always enabled
string
required
The display name of the post type (e.g., ‘Classified’, ‘Event’)
integer
required
The numeric type identifier for the post type (e.g., 4 for custom post types)
string
required
The name of the form/fields associated with this post type (e.g., ‘test_fields’, ‘classified_fields’)
string
Date format or configuration for posts
string
Additional post type configuration
string
Whether the post type is active (1 for active, 0 for inactive)
string
Tab name for profile navigation
string
required
The system identifier for the post type, typically matches data_filename (e.g., ‘test_category’, ‘classified’)
string
Custom SQL query for category filtering
string
Tab name for category navigation
string
Custom code for comments integration
string
required
The filename identifier for the post type, typically lowercase with underscores (e.g., ‘test_category’, ‘classified’)
integer
Display order for sorting post types
integer
Maximum length for captions/excerpts
integer
Category group identifier
HTML/text content for the footer
Footer content for profile pages
string
Header content for profile pages
string
Search results configuration
HTML/text content for the category footer
string
HTML/text content for the category header
string
Header text for comments section
Whether distance-based search is enabled (1 for yes, 0 for no)
string
Sidebar configuration for profile pages
string
Sidebar configuration for category pages
string
Default sorting order for profile listings
integer
Number of items per page in profile view
integer
Software version number
string
Default sorting order for category listings (e.g., ‘publish-desc’, ‘title-asc’)
string
Comma-separated list of featured categories
string
Timestamp for the last revision (format: YYYY-MM-DD HH:MM:SS)
string
HTML div configuration for search results
integer
Display order in user profiles
string
Layout template for search results
string
Search module configuration for sidebar
string
Layout template for profile results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_DATA_POSTTool 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

number
Latitude coordinate for geolocation
number
Longitude coordinate for geolocation
integer
required
The data category ID for this post
integer
required
The ID of the user who owns this post
string
State short name/code (e.g., CA)
integer
required
The type of post (e.g., 20 for Single Image Post)
string
Comma-separated list of tags for the post
string
Type classification for the post
string
Country short name/code (e.g., US)
string
Image URL or path for the post
string
required
The title of the post
string
Security token for the post
string
Author name for the post
integer
Number of clicks/views for the post
integer
required
The status of the post (0: inactive, 1: active/published)
integer
Whether the post is sticky/pinned (0: no, 1: yes)
string ("disabled" | "enabled")
Auto geocode option for data posts.
string
required
HTML content of the post
string
Category name for the post
string
URL-friendly filename/slug for the post
integer
Whether image has been imported (0: no, 1: yes)
string
Date when post goes live in format YYYYMMDDHHMMSS
integer
Recurring event type (0: not recurring)
integer
Number of revisions for the post
string
Start date for the post in format YYYYMMDDHHMMSS
string
Expiration date for the post in format YYYYMMDDHHMMSS
string ("disabled" | "enabled")
Auto image import option for data posts.
string
Original URL of the image to be imported
string
Timestamp of last revision in format YYYYMMDDHHMMSS
string
Expiration date for sticky post in format YYYY-MM-DD HH:MM:SS

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_LEADTool 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

number
The latitude coordinate for the lead location
number
The longitude coordinate for the lead location
number
The northeast latitude boundary
number
The northeast longitude boundary
number
The southwest latitude boundary
number
The southwest longitude boundary
integer
The status of the lead (numeric status code)
integer
The sub-category ID to associate with this lead
integer
The top-level category ID to associate with this lead
integer
The lead ID (typically only used for updates, not creation)
string
The name of the form used to submit the lead
string
The URL/page from which the lead was submitted
string
The name of the lead/contact person
string
The IP address of the lead submitter
string ("disabled" | "enabled")
Whether to automatically match this lead with members (0 = disabled, 1 = enabled)
string
The country code (ISO 2-letter code)
string
The date the lead was added in YYYYMMDDHHMMSS format
string
The email address of the lead
string
Admin notes about the lead (not visible to the lead)
string
The phone number of the lead
number
The price to charge members to view this lead
integer
The sub-sub-category ID to associate with this lead
string
The flow source identifier for tracking
string
The state/province code (administrative level 1)
string ("disabled" | "enabled")
Whether to automatically geocode the lead location (0 = disabled, 1 = enabled)
string
The message or inquiry from the lead
string
The location description for the lead
string
The type of location (e.g., country, city, region)
string
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
string
The name of the sub-category
string
The name of the top-level category
string
The revision timestamp in YYYYMMDDHHMMSS format
string
The name of the sub-sub-category
string ("disabled" | "enabled")
Whether to send email notification to matched members (0 = disabled, 1 = enabled)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_PORTFOLIO_GROUPCreates 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_UNSUBSCRIBETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_USERCreates a Brilliant Directories user or member account with email, a password of at least six characters, and a membership plan ID, plus optional personal, contact, address, profile, and status fields. Returns modeled user data including the user ID, token, and plan ID.

Input Parameters

string
City name
string
required
The user’s email address
integer
Account status (0: inactive, 1: active)
string
Company name
string
User’s website URL
string
User description
string
Primary address
string
Secondary address
string
required
The user’s password (minimum 6 characters)
string
Job position
integer
Verification status (0: unverified, 1: verified)
string
ZIP/Postal code
string
User’s last name
string
User’s first name
string
State code (e.g., CA)
string
Country code (e.g., US)
string
Contact phone number
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_USERS_CLICKTool 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

integer
ID of the post associated with the click (if applicable)
integer
required
The ID of the user who clicked the link
integer
Primary key identifier for the click record (used for updates)
string
IP address of the user who clicked the link
string
required
The URL that was clicked by the user
string
required
Source page or location where the click originated (e.g., ‘profile_page’, ‘listing_page’, ‘search_results’)
string
required
Display name or label for the clicked link
string
required
Type of link that was clicked (e.g., ‘link’, ‘email’, ‘phone’)
string
Unique token identifier for the click event
string
required
Timestamp when the link was clicked in format YYYYMMDDHHmmss (e.g., 20240213120000 for February 13, 2024 at 12:00:00)
string
Token identifying the visitor who clicked the link
integer
Flag indicating if the click is from a single post (0 = No, 1 = Yes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_CREATE_WIDGETTool 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

string
The HTML/PHP content/data for the widget
string
required
The name/title of the widget to create
string
CSS styles for the widget
string
JavaScript code for the widget

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_ALBUM_PHOTOTool 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

integer
required
The photo_id of the users_portfolio (Primary Key) to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_DATA_CATEGORYTool 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

integer
required
The data_id of the data_categories (Primary Key) to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_LEADTool to delete a lead and their related data from the database. Use when you need to permanently remove a lead record.

Input Parameters

integer
required
The lead_id of the leads (Primary Key). The unique identifier of the lead to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_PORTFOLIO_GROUPTool 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

integer
required
The group_id of the users_portfolio_groups (Primary Key) to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_UNSUBSCRIBETool 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

integer
required
The id of the unsubscribe_list record to delete (Primary Key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_USERDeletes a Brilliant Directories user and related data, with an option to delete the member’s uploaded image files.

Input Parameters

string
required
The unique identifier of the user to be deleted
integer
Whether to delete the user’s uploaded images (0 = No, 1 = Yes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_USERS_CLICKTool to delete a user clicked link and their related data from the database. Permanently removes a click record identified by click_id.

Input Parameters

integer
required
The click_id of the users_clicks record to delete (Primary Key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_DELETE_WIDGETTool 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

integer
required
The widget_id of the data_widgets (Primary Key). This is the unique identifier of the widget to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_ALBUM_PHOTORetrieves an album image by photo ID, returning supported metadata such as title, description, file paths, timestamps, and status.

Input Parameters

string
required
The photo_id of the users_portfolio (Primary Key). This is the unique identifier for the album image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_DATA_CATEGORIESThis 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_DATA_CATEGORYRetrieves configuration data for a single Brilliant Directories post type by data ID, including identifying fields and search configuration.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_DATA_POSTRetrieves a single image or video member post by post ID, returning supported post content, author, category, and associated user information.

Input Parameters

string
required
The unique identifier (Primary Key) of the data post to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_LEADRetrieves a lead by ID from Brilliant Directories, returning supported contact, inquiry, location, category, and other lead details.

Input Parameters

string
required
The lead_id of the lead to retrieve (Primary Key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_LEAD_FIELDSReturns a fixed list of lead field names, types, labels, and required and system-field flags after an API connectivity check. The list is not dynamically retrieved from the website’s lead schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_PORTFOLIO_GROUPRetrieves a multi-image post by group ID, returning supported post fields such as description, location, tags, image references, and property details when available.

Input Parameters

string
required
The unique identifier (primary key) of the users_portfolio_groups record to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_REVIEWTool 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

string
required
The review_id of the users_reviews (Primary Key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_REVIEWS_FIELDSReturns a fixed set of review field definitions, including names, types, descriptions, and required flags. It is read-only and makes no API call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_UNSUBSCRIBETool 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

string
required
The ID of the unsubscribe record (Primary Key). This is the unique identifier for the unsubscribe list entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_USERTool 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

string
required
The user_id of the user (Primary Key). This is the unique identifier for the user in the database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_USER_FIELDSRetrieves 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

string
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_USER_TRANSACTIONSRetrieves payment and transaction history for a member using both user_id and client_id. The response may include transaction details and, when return_schema is enabled, user schema and credit card information.

Input Parameters

integer
required
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.
integer
required
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.
string ("no" | "yes")
Enum for return_schema parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_GET_WIDGETRetrieves 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

string
required
The widget_id of the data_widgets (Primary Key). Use this to retrieve specific widget configuration and settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_MATCH_LEADSTool 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

integer
required
The unique identifier of the lead to match users to. Must be an existing lead ID in the system
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_SEARCH_REVIEWSSearch 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

string
Enter a keyword to search for in review data
integer
Enter the page number of results to return. For example, enter 2 to return the second page of results
integer
Enter the maximum number of review results to return per page of results
string
Enter the location to search for. Example: Los Angeles, California, United States
string ("html" | "array")
Output type options for response format.
integer
Set from 0 to 5 to filter the review by overall rating
string ("date-asc" | "date-desc" | "random")
Order by options for search results.
integer
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
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_SEARCH_USERSSearch 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

string
Keyword to search for in member data. Searches across multiple user fields like name, company, description, etc.
integer
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.
integer
Sub Level Category ID to filter members. When dynamic filter is enabled (dynamic=1), provide a comma-separated list of IDs.
integer
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.
string ("reviews" | "name ASC" | "name DESC" | "last_name_asc" | "last_name_desc")
Enum for sort order options.
integer
Sub-Sub Level Category ID to filter members. When dynamic filter is enabled (dynamic=1), provide a comma-separated list of IDs.
integer
Maximum number of search results to return per page. Controls pagination size.
string
Location to search for. Use full address format (e.g., ‘Los Angeles, California, United States’)
integer ("0" | "1")
Enum for dynamic category filter options.
string ("html" | "array")
Enum for output type options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_ALBUM_PHOTOUpdates 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_DATA_CATEGORYTool 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

string
The H1 heading text for the category page
string
The H2 heading text for the category page
string
The icon HTML/CSS for the category
integer
required
The unique identifier of the data category (post type) to update
string
Whether comments are enabled (0 = no, 1 = yes)
integer
Number of items to display per page in category view
integer
Whether the category is always visible (0 = no, 1 = yes)
string
The name of the data category (e.g., ‘Classified’, ‘Article’)
integer
The type identifier for the data category
string
The name of the form associated with this data category
string
Default post date configuration
string
Post type configuration
string
Whether the data category is active (0 = inactive, 1 = active)
string
The tab name on profile pages
string
The system name identifier for the data category
string
Custom SQL query for the category
string
The tab name for the category
string
Custom code for comments integration
string
The filename identifier for the data category
integer
The display order/position of this category
integer
Maximum length of captions/excerpts
integer
The group identifier for this category
Additional footer content
Footer content for profile pages
string
Header content for profile pages
string
Search results configuration
Footer content for the category page
string
Header content for the category page
string
Header content for comments section
integer
Whether distance-based search is enabled (0 = no, 1 = yes)
string
Sidebar template for profile pages
string
Sidebar template for category pages
string
Default ordering for profile results
integer
Number of items to display per page in profile view
integer
The software version identifier
string
Default ordering for category results
string
Comma-separated list of featured categories
string
The revision timestamp in format YYYY-MM-DD HH:MM:SS
string
Search results div configuration
integer
The display order on profile pages
string
The layout template for search results
string
The search module template for the sidebar
string
The layout template for profile results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_DATA_POSTUpdates a single image post and related data by post ID, including content, status, and metadata. The API requires data ID and data type as well as post ID; other supplied fields specify the changes.

Input Parameters

number
Latitude coordinate for the post location.
number
Longitude coordinate for the post location.
integer
Data identifier for the post.
integer
required
The unique identifier of the post to update. This is the primary key of the post record.
integer
The ID of the user associated with the post.
string
State short name/code (e.g., CA, NY).
integer
Type identifier for the data.
string
Comma-separated list of tags for the post.
string
Type of the post.
string
Country short name/code (e.g., US, CA).
string
Image URL or path associated with the post.
string
The title of the post.
string
Security token for the post.
string
The author name of the post.
integer
Number of clicks on the post.
integer
Status of the post (0: inactive/draft, 1: active/published).
integer
Whether the post is pinned/sticky (0: no, 1: yes).
integer
Whether to automatically geocode the location (0: no, 1: yes).
string
The main content of the post. Can include HTML formatting.
string
The category name for the post.
string
URL-friendly slug/filename for the post.
integer
Whether the image has been imported (0: no, 1: yes).
string
Live/publish date for the post in YYYYMMDDHHMMSS format.
integer
Recurring type indicator for the post.
integer
Number of revisions made to the post.
string
Start date for the post in YYYYMMDDHHMMSS format.
string
Expiration date for the post in YYYYMMDDHHMMSS format.
integer
Whether to automatically import images (0: no, 1: yes).
string
URL of the original image before import.
string
Timestamp of the last revision in YYYYMMDDHHMMSS format.
string
Expiration date for sticky post status in datetime format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_LEADUpdates 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

number
Latitude coordinate for lead location
number
Longitude coordinate for lead location
number
Northeast boundary latitude for lead service area
number
Northeast boundary longitude for lead service area
number
Southwest boundary latitude for lead service area
number
Southwest boundary longitude for lead service area
integer
Lead status code
integer
Sub-category ID for the lead
integer
Top-level category ID for the lead
integer
required
The unique identifier of the lead to update (required)
string
Name of the form used to capture this lead
string
URL from which the lead was submitted
string
Full name of the lead contact person
string
IP address from which the lead was submitted
string ("disabled" | "enabled")
Auto-match option for connecting leads to members
string
Country short name code (e.g., US, CA, GB)
string
Date when the lead was added (format: YYYYMMDDHHmmss)
string
Email address of the lead
string
Admin notes about this lead (internal use)
string
Phone number of the lead
number
Price associated with this lead (if charging for lead access)
integer
Sub-sub-category ID for the lead
string
Source flow identifier for tracking lead origin
string
State or province short name code
string ("disabled" | "enabled")
Auto-geocode option for lead location
string
Message or inquiry from the lead
string
Location description for the lead
string
Type of location (e.g., country, state, city)
string
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
string
Name of the sub-category
string
Name of the top-level category
string
Timestamp of the last revision (format: YYYYMMDDHHmmss)
string
Name of the sub-sub-category
string ("disabled" | "enabled")
Send email notification option

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_PORTFOLIO_GROUPTool 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

integer
Data ID associated with the portfolio group
integer
ID of the user who owns this portfolio group
integer
required
The unique identifier of the portfolio group to update (primary key)
string
State short name code (e.g., CA, NY, TX)
integer
Data type identifier for the portfolio group
string
Comma-separated list of tags for the post
string
Country short name code (e.g., US, CA, UK)
string
HTML description/content of the portfolio group
string
Name/title of the portfolio group or multi-image post
string
Comma-separated list of image filenames for the post
integer
Display order for the portfolio group
string
Unique token for the portfolio group
integer
Whether the post should be sticky/pinned (0 = no, 1 = yes)
string ("disabled" | "enabled")
Whether to automatically geocode location data
string
Update timestamp in format YYYYMMDDHHMMSS
integer
Status of the portfolio group (0 = inactive, 1 = active)
integer
Number of bedrooms (for real estate listings)
integer
Property type identifier (for real estate listings)
string
Category name for the portfolio group
string
Filename associated with the portfolio group
string
Location information for the portfolio group (HTML format)
integer
Number of bathrooms (for real estate listings)
integer
Property price (for real estate listings)
integer
Number of revisions for this portfolio group
integer
Property status identifier (for real estate listings)
string
Comma-separated list of titles for each image in the post
string ("disabled" | "enabled")
Whether to automatically import images
integer
Property square footage (for real estate listings)
string
Comma-separated list of descriptions for each image in the post
string
Expiration date for sticky post in format YYYY-MM-DD HH:MM:SS

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_UNSUBSCRIBEUpdates an existing unsubscribe list record in the Brilliant Directories database. Use this to modify unsubscribe settings for email campaigns.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_USERUpdates 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_USERS_CLICKUpdates 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRILLIANT_DIRECTORIES_UPDATE_WIDGETTool 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

integer
required
The unique identifier of the widget to update. Must be an existing widget ID in the system
string
The HTML/PHP content data of the widget
string
The name of the widget
string
The CSS style rules for the widget
string
The JavaScript code for the widget

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not