BridalLive offers an API for customers on the Elite plan, allowing you to build custom integrations and extend platform functionality.
This guide provides a high-level overview of how the API works and what to expect when building against it.
API Access & Requirements
API access is available to customers on the Elite plan and must be enabled on your account.
Once approved, you will receive:
- Retailer ID
- API Key
These can be found in:
Settings → Account → API
Environments
BridalLive provides two environments for development and production use. You will have a unique Retailer ID and API key for each account in each environment. Your environments will not overlap and data cannot be migrated.
QA (Testing Environment)
https://qa.bridallive.com
- Used for building and testing integrations
- Does not contain live data
Production
https://app.bridallive.com
- Your live BridalLive account
- Contains real customer and business data
Best practice: Always build and validate your integration in QA before moving to production.
Authentication
All API calls require authentication via token.
Endpoint
POST /bl-server/api/auth/apiLogin
Request Body
{
"retailerId": "YOUR_RETAILER_ID",
"apiKey": "YOUR_API_KEY"
}Response
Returns a token used for authenticated requests.
-
Token must be passed in request headers:
token: YOUR_TOKEN
- Tokens expire after approximately 8 hours
Base URLs
Use the same endpoints across environments with different base URLs:
QA
https://qa.bridallive.com/bl-server
Production
https://app.bridallive.com/bl-server
Common Endpoint Types
BridalLive’s API follows standard patterns:
- POST → Create and list/filter data
- GET → Retrieve data
- PUT → Update records
- DELETE → Remove records
Common Examples
POST /api/contacts
POST /api/contacts/list
GET /api/contacts/{id}
PUT /api/appointments/{id}
POST /api/appointments/list
GET /api/appointments/getAvailableAppointments/{appointmentTypeId}/{date}
POST /api/appointments/createTransaction
Key Limitations & Important Notes
Understanding these behaviors is critical when building your integration.
No PATCH Support
BridalLive does not support PATCH requests. Partial updates are not available.
Full Request Bodies Required for Many Updates
Even when using PUT, many endpoints expect a complete object payload, not just the fields you want to change.
What this means:
- You should retrieve the existing record first
- Modify the necessary fields
- Send the full object back in your update request
Token-Based Authentication Required
Most endpoints require a valid token in the request header:
token: YOUR_TOKEN
Token Expiration
Tokens expire after ~8 hours. Your integration should:
- Detect expiration
- Automatically re-authenticate
Error Handling
You may encounter responses such as:
-
401→ Unauthorized (invalid or expired token) -
409→ Conflict -
500→ Server error
Responses may include an errors object with additional details.
QA Testing is Required
All integrations should be tested in QA before production use.
Unvalidated or malformed API usage in production may result in restricted API access.
Recommended Development Workflow
A typical integration flow:
- Authenticate and store the token
- Build and test requests in QA
- Confirm required request structures per endpoint
- Implement error handling and token refresh logic
- Move to production once validated
BridalLive recommends using tools like Postman during development.
API Testing Tools (Recommended)
BridalLive recommends using an API client such as Postman when building and testing your integration.
While the Swagger documentation includes a built-in interface (Swagger UI), it is best used for reference and exploration only, not for full integration development.
Why use an API client like Postman:
- Easily manage authentication tokens across requests
- Save and organize endpoint calls into collections
- Test complex workflows (multiple dependent API calls)
- Debug errors with clearer request/response visibility
- Switch between QA and Production environments quickly
Recommended approach:
- Use Swagger to understand available endpoints and request structures
- Build and test your requests in Postman
- Validate workflows in QA before moving to production
Full API Documentation
For complete endpoint details, request/response models, and testing tools:
Swagger Documentation
https://www.bridallive.com/docs/swagger/index.html
Final Notes
BridalLive’s API is flexible but requires careful handling of request structures and authentication.
Taking time to validate payloads and test thoroughly in QA will ensure a stable and reliable integration.