API Reference - Multi Image Posts
Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108051
← Back to API Reference | Getting Started
Album Groups
Album groups are photo album containers on member profiles. Each group can contain multiple individual photos (see Album Photos). Albums are used for portfolios, project galleries, and product showcases.
Model name in URL:
users_portfolio_groups — DB table: users_portfolio_groupsThe Album Group Object
| Field | Type | Description |
|---|---|---|
group_id | integer | Unique album group ID (primary key, read-only) |
user_id | integer | ID of the member who owns this album required on create |
data_id | integer | Post type (data category) ID required on create |
group_name | string | Album name/title |
group_desc | text | Album description or content |
group_location | string | Location associated with this album |
group_date | timestamp | Album date/timestamp |
group_order | integer | Display order on profile |
group_status | integer | 0=Hidden, 1=Published |
group_token | string | Unique group token (auto-generated) |
group_filename | string | URL-friendly album slug |
group_type | string | Album type or category |
group_category | string | Category classification |
sticky_post | integer | 1 if album is pinned to the top |
post_tags | text | Comma-separated tags |
post_location | string | Post location text |
lat | string | Latitude coordinate |
lon | string | Longitude coordinate |
property_status | string | Property status (for real estate post types) |
property_type | string | Property type (for real estate post types) |
property_price | number | Property price (for real estate post types) |
property_beds | string | Number of bedrooms |
property_baths | string | Number of bathrooms |
property_sqr_foot | number | Square footage |
revision_timestamp | timestamp | Last modified timestamp (auto-updated) |
revision_count | integer | Number of times this album has been edited |
date_updated | string | Date album was last updated |
structure_id | integer | Structure template ID for this album type |
facebook_id | string | Facebook album ID (for imported Facebook albums) |
additional_fields | text | Custom field data stored as serialized or JSON content |
data_type | integer | Data type classification ID required on create |
sticky_post_expiration_date | date | Date when sticky post status expires |
country_sn | string | Country short name/code (e.g. US) |
state_sn | string | State/province short name/code (e.g. CA) |
post_availability | string | Availability status of the post |
post_promo | string | Promotional text or code for this post |
logged_user | integer | ID of the user who last saved this post |
digital_product_payment_type | string | Payment type for digital product posts (EG one-time, recurring) |
digital_product_monthly_enable | integer | Whether monthly billing is enabled for digital product posts |
digital_product_quarterly_enable | integer | Whether quarterly billing is enabled for digital product posts |
digital_product_semi_annually_enable | integer | Whether semi-annual billing is enabled for digital product posts |
digital_product_annually_enable | integer | Whether annual billing is enabled for digital product posts |
digital_product_biennially_enable | integer | Whether biennial billing is enabled for digital product posts |
digital_product_triennially_enable | integer | Whether triennial billing is enabled for digital product posts |
digital_product_one_time_donation_enable | integer | Whether one-time donation is enabled for digital product posts |
digital_product_monthly_price | number | Monthly price for digital product posts |
add_credits | integer | Whether purchasing this post adds credits to the buyer |
add_credits_amount | number | Number of credits to add upon purchase |
thank_you_page | string | URL or page slug to redirect to after purchase |
email_template_name | string | Email template sent to the buyer after purchase |
admin_email_template_name | string | Email template sent to the admin after purchase |
pid | string | External product or payment ID |
auto_image_import | integer | Whether to auto-import images for this post |
post_image | string | Featured image filename for this post |
venue_style_tags | string | Style tags for venue-type posts |
venue_capacity_max | integer | Maximum capacity for venue-type posts |
venue_price_range | string | Price range for venue-type posts |
static_url | string | Custom static URL override for this post |
List Album Groups
GET /api/v2/users_portfolio_groups/get
Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_portfolio_groups/get?property=user_id&property_value=42" \ -H "X-Api-Key: your-api-key-here"
Retrieve an Album Group
GET /api/v2/users_portfolio_groups/get/{group_id}
Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_portfolio_groups/get/15" \ -H "X-Api-Key: your-api-key-here"
Create an Album Group
POST /api/v2/users_portfolio_groups/create
The data_type parameter is required. The value can be obtained from the Post Types endpoint (data_categories/get).
Copy
curl -X POST "https://www.yourdomain.com/api/v2/users_portfolio_groups/create" \ -H "X-Api-Key: your-api-key-here" \ -d "user_id=42" \ -d "data_id=5" \ -d "data_type=4" \ -d "group_name=Kitchen+Remodel+Portfolio" \ -d "group_desc=Photos+from+recent+kitchen+renovation+projects" \ -d "group_status=1"
Update an Album Group
PUT /api/v2/users_portfolio_groups/update
Copy
curl -X PUT "https://www.yourdomain.com/api/v2/users_portfolio_groups/update" \ -H "X-Api-Key: your-api-key-here" \ -d "group_id=15" \ -d "group_name=Updated+Album+Name"
Delete an Album Group
DELETE /api/v2/users_portfolio_groups/delete
Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/users_portfolio_groups/delete" \ -H "X-Api-Key: your-api-key-here" \ -d "group_id=15"
Search Album Groups
POST /api/v2/users_portfolio_groups/search
Copy
curl -X POST "https://www.yourdomain.com/api/v2/users_portfolio_groups/search" \ -H "X-Api-Key: your-api-key-here" \ -d "q=kitchen" \ -d "data_id=5"
