API Reference - User Settings

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108064

← Back to API Reference | Getting Started

User Settings

User Settings store per-member configuration preferences such as matching preferences, marketing opt-ins, profile completion flags, and custom content injection. Each member has one settings record.

Model name in URL: users_setting — DB table: users_setting

The User Settings Object

FieldTypeDescription
setting_idintegerUnique settings record ID (primary key, read-only)
user_idintegerID of the member this settings record belongs to (foreign key to users)
match_onintegerWhether lead matching is enabled for this member (0 = off, 1 = on)
match_distancestringMaximum distance (in miles) for lead matching
match_budgetintegerMinimum budget threshold for lead matching
match_projectintegerProject type filter for lead matching
match_buildingsstringBuilding type filter for lead matching (EG All)
market_onintegerWhether marketing is enabled (0 = off, 1 = on)
market_naturalintegerWhether organic/natural marketing is enabled
market_paidintegerWhether paid marketing is enabled
market_photosintegerWhether photo-based marketing is enabled
market_socialintegerWhether social media marketing is enabled
market_facebookintegerWhether Facebook marketing is enabled
date_updatedstringDate the settings were last updated, formatted as YYYYMMDDHHmmss
tokenstringAuthentication token associated with this member's settings
complete_contactintegerWhether the contact info section of the profile is complete (0 or 1)
complete_resumeintegerWhether the resume section of the profile is complete
complete_photointegerWhether the photo section of the profile is complete
complete_aboutintegerWhether the about section of the profile is complete
complete_portfoliointegerWhether the portfolio section of the profile is complete
show_completeintegerWhether to show the profile completion indicator to the member
listing_commentsintegerWhether comments are enabled on this member's listing
listing_autoapproveintegerWhether reviews/comments auto-approve without moderation
insurancestringInsurance information for this member
blog_link_textstringDisplay text for the member's external blog link
blog_link_urlstringURL for the member's external blog link
hold_reasonstringReason this member's account is on hold, if applicable
hold_datestringDate this member's account was placed on hold
hold_notestextAdministrative notes about the account hold
dealboxtextDeal or offer content for this member's listing
content_headtextCustom HTML to inject into the <head> of this member's listing page
content_csstextCustom CSS to inject into this member's listing page
revision_timestamptimestampTimestamp of the last update to this record (auto-managed by the database)

List User Settings Records

GET /api/v2/users_setting/get

Returns a paginated list of user settings records.

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_setting/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "tablesExists": true,
      "setting_id": "1",
      "user_id": "1",
      "match_on": "1",
      "match_distance": "50",
      "match_budget": "0",
      "match_project": "0",
      "match_buildings": "All",
      "market_on": "1",
      "market_natural": "1",
      "market_paid": "1",
      "market_photos": "1",
      "market_social": "1",
      "market_facebook": "1",
      "date_updated": "20150810141636",
      "token": "",
      "complete_contact": "1",
      "complete_resume": "0",
      "complete_photo": "0",
      "complete_about": "1",
      "complete_portfolio": "1",
      "show_complete": "1",
      "listing_comments": "0",
      "listing_autoapprove": "0",
      "insurance": "",
      "blog_link_text": "",
      "blog_link_url": "",
      "hold_reason": "",
      "hold_date": "",
      "hold_notes": "",
      "dealbox": "",
      "content_head": "",
      "content_css": "",
      "revision_timestamp": "2025-11-14 19:45:54"
    }
  ],
  "total": "146",
  "current_page": 1,
  "total_pages": 73,
  "next_page": "MipfKjI="
}

Retrieve a User Settings Record

GET /api/v2/users_setting/get/{setting_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_setting/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "tablesExists": true,
      "setting_id": "1",
      "user_id": "1",
      "match_on": "1",
      "match_distance": "50",
      "match_budget": "0",
      "match_project": "0",
      "match_buildings": "All",
      "market_on": "1",
      "market_natural": "1",
      "market_paid": "1",
      "market_photos": "1",
      "market_social": "1",
      "market_facebook": "1",
      "date_updated": "20150810141636",
      "token": "",
      "complete_contact": "1",
      "complete_resume": "0",
      "complete_photo": "0",
      "complete_about": "1",
      "complete_portfolio": "1",
      "show_complete": "1",
      "listing_comments": "0",
      "listing_autoapprove": "0",
      "insurance": "",
      "blog_link_text": "",
      "blog_link_url": "",
      "hold_reason": "",
      "hold_date": "",
      "hold_notes": "",
      "dealbox": "",
      "content_head": "",
      "content_css": "",
      "revision_timestamp": "2025-11-14 19:45:54"
    }
  ],
  "total": "146",
  "current_page": 1,
  "total_pages": 6,
  "next_page": "MipfKjI1"
}

Create a User Settings Record

POST /api/v2/users_setting/create

Creates a new settings record for a member.

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/users_setting/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "user_id=500" \
  -d "match_on=1" \
  -d "match_distance=50" \
  -d "market_on=1"

Example Response

Copy
{
  "status": "success",
  "message": {
    "setting_id": "910037",
    "user_id": "500",
    "match_on": "1",
    "match_distance": "50",
    "match_budget": null,
    "match_project": null,
    "match_buildings": null,
    "market_on": "1",
    "market_natural": null,
    "market_paid": null,
    "market_photos": null,
    "market_social": null,
    "market_facebook": null,
    "date_updated": null,
    "token": null,
    "complete_contact": null,
    "complete_resume": null,
    "complete_photo": null,
    "complete_about": null,
    "complete_portfolio": null,
    "show_complete": null,
    "listing_comments": null,
    "listing_autoapprove": null,
    "insurance": null,
    "blog_link_text": null,
    "blog_link_url": null,
    "hold_reason": null,
    "hold_date": null,
    "hold_notes": null,
    "dealbox": null,
    "content_head": null,
    "content_css": null,
    "revision_timestamp": null
  }
}

Update a User Settings Record

PUT /api/v2/users_setting/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/users_setting/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "setting_id=910037" \
  -d "match_distance=100"

Example Response

Copy
{
  "status": "success",
  "message": {
    "setting_id": "910037",
    "user_id": "500",
    "match_on": "1",
    "match_distance": "100",
    "match_budget": "0",
    "match_project": "0",
    "match_buildings": "",
    "market_on": "1",
    "market_natural": "0",
    "market_paid": "0",
    "market_photos": "0",
    "market_social": "0",
    "market_facebook": "0",
    "date_updated": "",
    "token": "",
    "complete_contact": "0",
    "complete_resume": "0",
    "complete_photo": "0",
    "complete_about": "0",
    "complete_portfolio": "0",
    "show_complete": "0",
    "listing_comments": "0",
    "listing_autoapprove": "0",
    "insurance": "",
    "blog_link_text": "",
    "blog_link_url": "",
    "hold_reason": "",
    "hold_date": "",
    "hold_notes": "",
    "dealbox": "",
    "content_head": "",
    "content_css": "",
    "revision_timestamp": "2026-04-03 23:23:45"
  }
}

Delete a User Settings Record

DELETE /api/v2/users_setting/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/users_setting/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "setting_id=910037"

Example Response

Copy
{
  "status": "success",
  "message": "users_setting record was deleted"
}