- Category: website builders
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 44
- Triggers: 0
- Slug:
BRILLIANT_DIRECTORIES - Version: 20261101_00
Tools
Create Album Photo
Create Album Photo
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
Output
Create Data Category
Create Data Category
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
Output
Create Data Post
Create Data Post
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
Output
Create Lead
Create Lead
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
Output
Create Portfolio Group
Create Portfolio Group
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
Output
Create Unsubscribe
Create Unsubscribe
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
Output
Create User
Create User
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
Output
Create Users Click
Create Users Click
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
Output
Create Widget
Create Widget
Delete Album Photo
Delete Album Photo
Delete Data Category
Delete Data Category
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
Output
Delete Lead
Delete Lead
Delete Portfolio Group
Delete Portfolio Group
Delete Unsubscribe Record
Delete Unsubscribe Record
Delete User
Delete User
Delete Users Click
Delete Users Click
Delete Widget
Delete Widget
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
Output
Get Album Photo
Get Album Photo
Get Data Categories Fields
Get Data Categories Fields
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
Get Data Category
Get Data Category
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
Output
Get Data Post
Get Data Post
Get Lead
Get Lead
Get Lead Fields
Get Lead Fields
Get Portfolio Group
Get Portfolio Group
Get Review
Get Review
Get Reviews Fields
Get Reviews Fields
Get Unsubscribe Record
Get Unsubscribe Record
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
Output
Get User by ID
Get User by ID
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
Output
Get User Data
Get User Data
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 linksInput Parameters
Output
Get User Clicked Link
Get User Clicked Link
BRILLIANT_DIRECTORIES_GET_USERS_CLICKTool 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
Output
Get User Transactions
Get User Transactions
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
Output
Get Widget
Get Widget
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
Output
Match Leads
Match Leads
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
Output
Search Reviews
Search Reviews
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
Output
Search Users
Search Users
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
Output
Update Album Photo
Update Album Photo
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
Output
Update Data Category
Update Data Category
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
Output
Update Data Post
Update Data Post
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
Output
Update Lead
Update Lead
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
Output
Update Portfolio Group
Update Portfolio Group
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
Output
Update Unsubscribe
Update Unsubscribe
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
Output
Update User
Update User
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
Output
Update User Click Record
Update User Click Record
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
Output
Update Widget
Update Widget
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.