The Brilliant Directories connector lets your AI agent act in each user's Brilliant Directories account. Each user connects their own Brilliant Directories API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 48 tools.
- Tools
- 48
- What they doRead · write · destructive
- 27 · 14 · 727 read14 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Brilliant Directories connection
In AgentKit > Connections, create a Brilliant Directories connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'brilliantdirectories'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Brilliant Directories:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'brilliantdirectories_album_photos_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "brilliantdirectories"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Brilliant Directories:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="brilliantdirectories_album_photos_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Brilliant Directories credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbrilliantdirectories_album_getGet one multi-image post (album) by ID.Read-onlyGet Album
Get one multi-image post (album) by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_albums_list.
Inputs
group_idstringrequired- ID of the multi-image post (album). Example: 77.
brilliantdirectories_album_photo_getGet one album photo by ID.Read-onlyGet Album Photo
Get one album photo by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_album_photos_list.
Inputs
photo_idstringrequired- ID of the album photo. Example: 905.
brilliantdirectories_album_photos_listList album photos on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Album Photos
List album photos on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of album photo records with total and next_page. Use brilliantdirectories_album_photo_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_albums_listList multi-image post (album)s on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Albums
List multi-image post (album)s on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of multi-image post (album) records with total and next_page. Use brilliantdirectories_album_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_api_key_verifyCheck that the API key is valid.Read-onlyVerify API Key
Check that the API key is valid. Returns the website URL and the key's name. Use it as a connection test.
Inputs
This tool takes no inputs.
brilliantdirectories_click_getGet one member link click by ID.Read-onlyGet Click
Get one member link click by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_clicks_list.
Inputs
click_idstringrequired- ID of the member link click. Example: 9001.
brilliantdirectories_clicks_listList member link clicks on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Clicks
List member link clicks on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member link click records with total and next_page. Use brilliantdirectories_click_get for one record. Clicks record visitors clicking a member's links (website, phone, social).
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_lead_getGet one lead by ID.Read-onlyGet Lead
Get one lead by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_leads_list.
Inputs
lead_idstringrequired- ID of the lead. Example: 201.
brilliantdirectories_leads_listList leads on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Leads
List leads on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of lead records with total and next_page. Use brilliantdirectories_lead_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_member_categories_getGet the categories (professions and sub-categories) a member is listed under.Read-onlyGet Member Categories
Get the categories (professions and sub-categories) a member is listed under. Returns the member's category assignments.
Inputs
user_idstringrequired- ID of the member. Example: 42.
brilliantdirectories_member_getGet one member by ID.Read-onlyGet Member
Get one member by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_members_list.
Inputs
user_idstringrequired- ID of the member. Example: 42.
brilliantdirectories_member_subscriptions_listList a member's billing subscriptions, current and ended, each with its invoices.Read-onlyList Member Subscriptions
List a member's billing subscriptions, current and ended, each with its invoices. Returns subscriptions with plan, amount, cycle, next due date and status.
Inputs
client_idinteger- The member's billing client ID, instead of user_id. Example: 7429.
statusstring- active for active subscriptions only, ended for cancelled ones; empty for all. Example: active.one of
activeended user_idinteger- Member ID. Send user_id or client_id. Example: 42.
brilliantdirectories_member_transactions_listList every billing invoice of a member, each with the subscription it belongs to.Read-onlyList Member Transactions
List every billing invoice of a member, each with the subscription it belongs to. Returns invoices with dates, totals, status and items. Use brilliantdirectories_member_subscriptions_list for subscriptions.
Inputs
client_idinteger- The member's billing client ID, instead of user_id. Example: 7429.
user_idinteger- Member ID. Send user_id or client_id. Example: 42.
brilliantdirectories_members_listList members on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Members
List members on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member records with total and next_page. Use brilliantdirectories_member_get for one record.
Inputs
include_labelsstring- 1 also returns the labels of dropdown, checkbox and radio fields as <field>_values_stringify. Example: 1.
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_members_searchSearch the member directory like the site's front-end search, by keyword, category and location, with sorting.Read-onlySearch Members
Search the member directory like the site's front-end search, by keyword, category and location, with sorting. Returns matching members. Use brilliantdirectories_members_list to filter by exact field values.
Inputs
addressstring- Location to search near, for example Los Angeles, CA. Example: Los Angeles, CA.
limitinteger- Results per page. Example: 25.
pageinteger- Page number. Example: 1.
pidinteger- Top-level category ID. Example: 12.
qstring- Keyword to search across member data. Example: plumber.
sortstring- Sort order. Example: reviews.one of
reviewsname ASCname DESClast_name_asclast_name_desc tidinteger- Sub-category ID. Example: 34.
ttidinteger- Sub-sub-category ID. Example: 56.
brilliantdirectories_post_getGet one single image post by ID.Read-onlyGet Post
Get one single image post by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_posts_list.
Inputs
post_idstringrequired- ID of the single image post. Example: 310.
brilliantdirectories_post_type_getGet one post type by ID.Read-onlyGet Post Type
Get one post type by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_post_types_list.
Inputs
data_idstringrequired- ID of the post type. Example: 3.
brilliantdirectories_post_types_listList post types on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Post Types
List post types on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of post type records with total and next_page. Use brilliantdirectories_post_type_get for one record. Post types define the kinds of posts members can publish (articles, events, jobs, properties...).
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_posts_listList single image posts on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Posts
List single image posts on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of single image post records with total and next_page. Use brilliantdirectories_post_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_posts_searchSearch single image posts by keyword, category, post type or member, like the site's front-end search.Read-onlySearch Posts
Search single image posts by keyword, category, post type or member, like the site's front-end search. Returns matching posts. Pass data_id to scope the search to one post type (strongly recommended).
Inputs
categorystring- Category to filter by. Example: Renovation.
data_idinteger- Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
limitinteger- Results per page. Example: 25.
pageinteger- Page number. Example: 1.
qstring- Keyword to search across post data. Example: renovation.
user_idinteger- Only posts by this member. Example: 42.
brilliantdirectories_review_getGet one member review by ID.Read-onlyGet Review
Get one member review by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_reviews_list.
Inputs
review_idstringrequired- ID of the member review. Example: 61.
brilliantdirectories_reviews_listList member reviews on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Reviews
List member reviews on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of member review records with total and next_page. Use brilliantdirectories_review_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_unsubscribe_getGet one unsubscribed email by ID.Read-onlyGet Unsubscribe
Get one unsubscribed email by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_unsubscribes_list.
Inputs
record_idstringrequired- ID of the unsubscribed email. Example: 15.
brilliantdirectories_unsubscribes_listList unsubscribed emails on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Unsubscribes
List unsubscribed emails on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of unsubscribed email records with total and next_page. Use brilliantdirectories_unsubscribe_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_widget_getGet one widget by ID.Read-onlyGet Widget
Get one widget by ID. Returns the record (in a one-item message array). Get IDs from brilliantdirectories_widgets_list.
Inputs
widget_idstringrequired- ID of the widget. Example: 500.
brilliantdirectories_widget_renderRender a widget and return its HTML output with template variables processed, for previews or embedding.Read-onlyRender Widget
Render a widget and return its HTML output with template variables processed, for previews or embedding. Returns the widget name and output HTML.
Inputs
widget_idintegerrequired- ID of the widget to render. Get IDs from brilliantdirectories_widgets_list. Example: 500.
brilliantdirectories_widgets_listList widgets on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column.Read-onlyList Widgets
List widgets on the directory site, 25 at a time with cursor paging, filtered by any field and sorted by any column. Returns a page of widget records with total and next_page. Use brilliantdirectories_widget_get for one record.
Inputs
limitinteger- Records per page: 25 by default, up to 100. Example: 25.
order_columnstring- Column to sort by, or a comma-separated list. Example: last_name.
order_typestring- Sort direction: ASC (default), DESC or RAND. Example: ASC.one of
ASCDESCRAND pagestring- Cursor token from the previous response's next_page (or prev_page). Leave empty for the first page. Example: MipfKjI1.
propertystring- Field name to filter on, for example active, email or signup_date. Example: active.
property_logicstring- Comparison operator: =, ne, gt, gte, lt, lte, like, in, contains, starts_with, since_days, between_dates and more. Defaults to =. Example: =.
property_valuestring- Value to compare property with (not needed for is_null / is_not_null). Example: 2.
brilliantdirectories_album_createCreate a multi-image post (album) with the given fields.WriteCreate Album
Create a multi-image post (album) with the given fields. Returns the new record with its group_id.
Inputs
data_idintegerrequired- Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
data_typeintegerrequired- Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
group_namestringrequired- Album name/title. Example: Kitchen Projects.
user_idintegerrequired- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
group_categorystring- Category classification. Example: Renovation.
group_descstring- Album description or content. Example: Recent kitchen remodels.
group_locationstring- Location associated with this album. Example: Los Angeles, CA.
group_statusinteger- 0 =Hidden, 1 =Published. Example: 1.
post_tagsstring- Comma-separated tags. Example: kitchen,remodel.
brilliantdirectories_album_photo_createCreate a album photo with the given fields.WriteCreate Album Photo
Create a album photo with the given fields. Returns the new record with its photo_id.
Inputs
group_idintegerrequired- Album group this photo belongs to required on create. Example: 77.
original_image_urlstringrequired- URL of the image to import into the album, for example https://www.example.com/images/kitchen-1.jpg. Example: https://www.example.com/images/kitchen-1.jpg.
user_idintegerrequired- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
descstring- Photo description. Example: White shaker cabinets with quartz counters.
keywordsstring- Keywords or tags for the photo. Example: kitchen,cabinets.
linkstring- URL associated with this photo. Example: https://www.example.com/projects/kitchen.
orderinteger- Display order within the album. Example: 1.
statusinteger- 0 =Hidden, 1 =Active. Example: 1.
titlestring- Photo title or caption. Example: Finished kitchen.
brilliantdirectories_album_photo_updateUpdate a album photo: send its photo_id and only the fields to change (empty values are ignored).WriteUpdate Album Photo
Update a album photo: send its photo_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_album_photos_list.
- Idempotent
Inputs
photo_idintegerrequired- ID of the album photo to update. Example: 905.
descstring- Photo description. Example: White shaker cabinets with quartz counters.
group_idinteger- Album group this photo belongs to required on create. Example: 77.
keywordsstring- Keywords or tags for the photo. Example: kitchen,cabinets.
linkstring- URL associated with this photo. Example: https://www.example.com/projects/kitchen.
orderinteger- Display order within the album. Example: 1.
original_image_urlstring- URL of the image to import into the album, for example https://www.example.com/images/kitchen-1.jpg. Example: https://www.example.com/images/kitchen-1.jpg.
statusinteger- 0 =Hidden, 1 =Active. Example: 1.
titlestring- Photo title or caption. Example: Finished kitchen.
user_idinteger- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
brilliantdirectories_album_updateUpdate a multi-image post (album): send its group_id and only the fields to change (empty values are ignored).WriteUpdate Album
Update a multi-image post (album): send its group_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_albums_list.
- Idempotent
Inputs
group_idintegerrequired- ID of the multi-image post (album) to update. Example: 77.
data_idinteger- Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
data_typeinteger- Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
group_categorystring- Category classification. Example: Renovation.
group_descstring- Album description or content. Example: Recent kitchen remodels.
group_locationstring- Location associated with this album. Example: Los Angeles, CA.
group_namestring- Album name/title. Example: Kitchen Projects.
group_statusinteger- 0 =Hidden, 1 =Published. Example: 1.
post_tagsstring- Comma-separated tags. Example: kitchen,remodel.
user_idinteger- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
brilliantdirectories_lead_createCreate a lead with the given fields.WriteCreate Lead
Create a lead with the given fields. Returns the new record with its lead_id.
Inputs
lead_emailstringrequired- Email address of the lead submitter. Example: bob@example.com.
lead_namestringrequired- Contact name of the lead submitter. Example: Bob Johnson.
lead_locationstring- Formatted location address for this lead. Example: Chicago, IL.
lead_messagestring- Full message/description of the lead request. Example: I need a plumber for a leak.
lead_notesstring- Internal notes about this lead. Example: Resolved by member #42.
lead_phonestring- Phone number of the lead submitter. Example: 555-123-4567.
lead_pricenumber- Price associated with this lead. Example: 15.00.
statusstring- Lead status. Example: 1.
sub_idinteger- Sub-category ID for matching. Example: 34.
top_idinteger- Top-level category ID for matching. Example: 12.
brilliantdirectories_lead_matchRun the lead-matching algorithm for a lead: find members whose category, location and service area match and email them the lead.WriteMatch Lead to Members
Run the lead-matching algorithm for a lead: find members whose category, location and service area match and email them the lead. Returns how many members were matched. Create the lead first with brilliantdirectories_lead_create.
Inputs
lead_idintegerrequired- ID of the lead to match. Example: 201.
brilliantdirectories_lead_updateUpdate a lead: send its lead_id and only the fields to change (empty values are ignored).WriteUpdate Lead
Update a lead: send its lead_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_leads_list.
- Idempotent
Inputs
lead_idintegerrequired- ID of the lead to update. Example: 201.
lead_emailstring- Email address of the lead submitter. Example: bob@example.com.
lead_locationstring- Formatted location address for this lead. Example: Chicago, IL.
lead_messagestring- Full message/description of the lead request. Example: I need a plumber for a leak.
lead_namestring- Contact name of the lead submitter. Example: Bob Johnson.
lead_notesstring- Internal notes about this lead. Example: Resolved by member #42.
lead_phonestring- Phone number of the lead submitter. Example: 555-123-4567.
lead_pricenumber- Price associated with this lead. Example: 15.00.
statusstring- Lead status. Example: 1.
sub_idinteger- Sub-category ID for matching. Example: 34.
top_idinteger- Top-level category ID for matching. Example: 12.
brilliantdirectories_member_createCreate a member with the given fields.WriteCreate Member
Create a member with the given fields. Returns the new record with its user_id.
Inputs
emailstringrequired- Email address — must be unique across the site required on create. Example: jane@example.com.
passwordstringrequired- Password (plain text on create/update; stored as a hash). Write-only — never returned in any API response required on create. Example: SecurePass123!.
subscription_idintegerrequired- Membership level ID required on create. Example: 1.
about_mestring- About Me biography (HTML allowed). Example: Licensed plumber with 15 years of experience.
activeinteger- Account status: 1 =Inactive, 2 =Active, 3 =Cancelled, 4 =On Hold, 5 =Past Due. Example: 2.
address1string- Street address line 1. Example: 100 Main St.
address2string- Street address line 2. Example: Suite 4.
billing_cyclestring- Renewal interval, sent together with subscription_start_date. Example: annually.one of
monthlyquarterlysemiannuallyannuallybienniallytriennially citystring- City. Example: Los Angeles.
companystring- Business or company name. Example: Acme Plumbing.
country_codestring- 2-letter country code (e.g. US ). Example: US.
featuredinteger- 1 if user is featured, 0 otherwise. Example: 1.
first_namestring- User's first name. Example: Jane.
last_namestring- User's last name. Example: Smith.
phone_numberstring- Phone number. Example: 555-555-1234.
profession_idinteger- Industry/profession category ID. Example: 12.
state_codestring- 2-letter state/province code (e.g. CA ). Example: CA.
subscription_start_datestring- Start date of an already-running paid subscription (YYYY-MM-DD); send together with billing_cycle. Example: 2026-01-15.
websitestring- User's website URL. Example: https://www.acmeplumbing.com.
zip_codestring- ZIP or postal code. Example: 90001.
brilliantdirectories_member_updateUpdate a member: send its user_id and only the fields to change (empty values are ignored).WriteUpdate Member
Update a member: send its user_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_members_list.
- Idempotent
Inputs
user_idintegerrequired- ID of the member to update. Example: 42.
about_mestring- About Me biography (HTML allowed). Example: Licensed plumber with 15 years of experience.
activeinteger- Account status: 1 =Inactive, 2 =Active, 3 =Cancelled, 4 =On Hold, 5 =Past Due. Example: 2.
address1string- Street address line 1. Example: 100 Main St.
address2string- Street address line 2. Example: Suite 4.
citystring- City. Example: Los Angeles.
companystring- Business or company name. Example: Acme Plumbing.
country_codestring- 2-letter country code (e.g. US ). Example: US.
emailstring- Email address — must be unique across the site required on create. Example: jane@example.com.
featuredinteger- 1 if user is featured, 0 otherwise. Example: 1.
first_namestring- User's first name. Example: Jane.
last_namestring- User's last name. Example: Smith.
passwordstring- Password (plain text on create/update; stored as a hash). Write-only — never returned in any API response required on create. Example: SecurePass123!.
phone_numberstring- Phone number. Example: 555-555-1234.
profession_idinteger- Industry/profession category ID. Example: 12.
state_codestring- 2-letter state/province code (e.g. CA ). Example: CA.
subscription_idinteger- Membership level ID required on create. Example: 1.
websitestring- User's website URL. Example: https://www.acmeplumbing.com.
zip_codestring- ZIP or postal code. Example: 90001.
brilliantdirectories_post_createCreate a single image post with the given fields.WriteCreate Post
Create a single image post with the given fields. Returns the new record with its post_id.
Inputs
data_idintegerrequired- Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
data_typeintegerrequired- Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
post_titlestringrequired- Post title/headline. Example: Spring Renovation Special.
user_idintegerrequired- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
post_captionstring- Short caption or excerpt. Example: 20% off kitchen remodels.
post_categorystring- Category name for this post. Example: Renovation.
post_contentstring- Full post content (HTML allowed). Example: <p>Book your kitchen remodel this spring and save 20%.</p>.
post_expire_datestring- Date post expires. Example: 20260601000000.
post_imagestring- Main image filename. Example: https://www.example.com/images/kitchen.jpg.
post_live_datestring- Date post goes live (format: YYYYMMDDHHmmss ). When left out on create, it defaults to the current time in the website's time zone (the Website Time Zone setting under Settings » General Settings » Localization), and a supplied value is stored as sent. Responses return it in ISO 8601 with the website's UTC offset for that date, EG 2026-11-09T13:07:03-08:00 on a website set to Pacific Time. Example: 20260301000000.
post_locationstring- Location or address. Example: Los Angeles, CA.
post_pricenumber- Price (for products or services). Example: 99.
post_statusinteger- 0 =Draft, 1 =Published. Example: 1.
post_tagsstring- Comma-separated tags. Example: kitchen,remodel.
brilliantdirectories_post_updateUpdate a single image post: send its post_id and only the fields to change (empty values are ignored).WriteUpdate Post
Update a single image post: send its post_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_posts_list.
- Idempotent
Inputs
post_idintegerrequired- ID of the single image post to update. Example: 310.
data_idinteger- Post type ID. Get IDs from brilliantdirectories_post_types_list. Example: 3.
data_typeinteger- Data type ID of the post type, required on create. Get it from the post type's data_type in brilliantdirectories_post_types_list. Example: 4.
post_captionstring- Short caption or excerpt. Example: 20% off kitchen remodels.
post_categorystring- Category name for this post. Example: Renovation.
post_contentstring- Full post content (HTML allowed). Example: <p>Book your kitchen remodel this spring and save 20%.</p>.
post_expire_datestring- Date post expires. Example: 20260601000000.
post_imagestring- Main image filename. Example: https://www.example.com/images/kitchen.jpg.
post_live_datestring- Date post goes live (format: YYYYMMDDHHmmss ). When left out on create, it defaults to the current time in the website's time zone (the Website Time Zone setting under Settings » General Settings » Localization), and a supplied value is stored as sent. Responses return it in ISO 8601 with the website's UTC offset for that date, EG 2026-11-09T13:07:03-08:00 on a website set to Pacific Time. Example: 20260301000000.
post_locationstring- Location or address. Example: Los Angeles, CA.
post_pricenumber- Price (for products or services). Example: 99.
post_statusinteger- 0 =Draft, 1 =Published. Example: 1.
post_tagsstring- Comma-separated tags. Example: kitchen,remodel.
post_titlestring- Post title/headline. Example: Spring Renovation Special.
user_idinteger- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
brilliantdirectories_review_createCreate a member review with the given fields.WriteCreate Review
Create a member review with the given fields. Returns the new record with its review_id.
Inputs
review_emailstringrequired- Email address of the reviewer. Example: bob@example.com.
review_namestringrequired- Name of the reviewer. Example: Bob Johnson.
user_idintegerrequired- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
rating_overallinteger- Overall rating (1–5). Example: 5.
recommendinteger- 1 if reviewer recommends this member. Example: 1.
review_descriptionstring- Full review text. Example: Fixed our leak the same day.
review_statusinteger- Approval status: 0 =Pending, 1 =Approved, 2 =Rejected. Example: 2.
review_titlestring- Review headline. Example: Fast and professional.
brilliantdirectories_review_updateUpdate a member review: send its review_id and only the fields to change (empty values are ignored).WriteUpdate Review
Update a member review: send its review_id and only the fields to change (empty values are ignored). Returns the updated record. Get IDs from brilliantdirectories_reviews_list.
- Idempotent
Inputs
review_idintegerrequired- ID of the member review to update. Example: 61.
rating_overallinteger- Overall rating (1–5). Example: 5.
recommendinteger- 1 if reviewer recommends this member. Example: 1.
review_descriptionstring- Full review text. Example: Fixed our leak the same day.
review_emailstring- Email address of the reviewer. Example: bob@example.com.
review_namestring- Name of the reviewer. Example: Bob Johnson.
review_statusinteger- Approval status: 0 =Pending, 1 =Approved, 2 =Rejected. Example: 2.
review_titlestring- Review headline. Example: Fast and professional.
user_idinteger- ID of the member. Get IDs from brilliantdirectories_members_list. Example: 42.
brilliantdirectories_unsubscribe_createCreate a unsubscribed email with the given fields.WriteCreate Unsubscribe
Create a unsubscribed email with the given fields. Returns the new record with its id.
Inputs
emailstringrequired- Email address that has unsubscribed required on create. Example: jane@example.com.
codestring- Source of unsubscribe: admin , email , or api. Example: ab12cd.
definitiveinteger- 1 for permanent unsubscribe, 0 for standard. Example: 1.
typestring- Type of unsubscribe (e.g. unsubscribe ). Example: 1.
brilliantdirectories_album_deletePermanently delete a multi-image post (album) and its associated data.DestructiveDelete Album
Permanently delete a multi-image post (album) and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_albums_list.
- Idempotent
Inputs
group_idintegerrequired- ID of the multi-image post (album) to delete. Example: 77.
brilliantdirectories_album_photo_deletePermanently delete a album photo and its associated data.DestructiveDelete Album Photo
Permanently delete a album photo and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_album_photos_list.
- Idempotent
Inputs
photo_idintegerrequired- ID of the album photo to delete. Example: 905.
brilliantdirectories_lead_deletePermanently delete a lead and its associated data.DestructiveDelete Lead
Permanently delete a lead and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_leads_list.
- Idempotent
Inputs
lead_idintegerrequired- ID of the lead to delete. Example: 201.
brilliantdirectories_member_deletePermanently delete a member and its associated data.DestructiveDelete Member
Permanently delete a member and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_members_list.
- Idempotent
Inputs
user_idintegerrequired- ID of the member to delete. Example: 42.
delete_imagesstring- 1 also deletes the member's uploaded image files. Example: 1.
brilliantdirectories_post_deletePermanently delete a single image post and its associated data.DestructiveDelete Post
Permanently delete a single image post and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_posts_list.
- Idempotent
Inputs
post_idintegerrequired- ID of the single image post to delete. Example: 310.
brilliantdirectories_review_deletePermanently delete a member review and its associated data.DestructiveDelete Review
Permanently delete a member review and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_reviews_list.
- Idempotent
Inputs
review_idintegerrequired- ID of the member review to delete. Example: 61.
brilliantdirectories_unsubscribe_deletePermanently delete a unsubscribed email and its associated data.DestructiveDelete Unsubscribe
Permanently delete a unsubscribed email and its associated data. Returns a confirmation message. Get IDs from brilliantdirectories_unsubscribes_list.
- Idempotent
Inputs
idintegerrequired- ID of the unsubscribed email to delete. Example: 15.
No tools match.