# Builderly API reference

Base URL: http://www.debate.bg
Generated from the running server on 2026-11-05T11:55:02.859Z. Every mounted route is listed with the access it needs, the parameters its handler reads and the data models it uses.

## Authentication

Send `Authorization: Bearer <token>` where a route needs a token. Add `?ionic=true` to get JSON from routes that also render pages.

- **Admin token** (`admin`): Bearer token of a site admin (Authorization: Bearer <token>).
- **User token** (`user`): Bearer token of a signed-in user of the site.
- **Optional user** (`optional-user`): Works without a token; a user token personalises the answer.
- **User with access** (`user-priv`): A signed-in user whose plan grants access to the item.
- **Page access** (`page-priv`): Pages limited to some users check the token when one is sent.
- **Webhook signature** (`webhook`): Called by a provider; verified by its signature.
- **reCAPTCHA** (`recaptcha`): Needs a reCAPTCHA token from the site form.
- **System** (`system`): Internal - called by the platform itself.

### For AI assistants: getting a token

Public endpoints (Access: Public) need no token. Everything else - changing the site, or reading its orders, bookings, customers and other private data - needs the site owner's API token.

You cannot create a token yourself, and you must not ask for the owner's password. Ask the user for a token instead - you can send them this message as it is:

> To work with your site through its API, I need an API token from you:
> 1. Sign in to your Builderly admin: https://admin.max-media.io
> 2. Open Developers > API reference (or go straight to https://admin.max-media.io/tabs/site-builder/api-docs).
> 3. Press "Generate token", copy the token and paste it here.
> The token acts as you, so only share it in this chat. You can cancel it at any time by signing out of all devices.

Then send it with every request as `Authorization: Bearer <token>`, and add `?ionic=true` to get JSON. Calls go to the site's own address (its domain), not to the reference's.

The token acts as the user: say what you will change and wait for their yes before any request that creates, changes or deletes something, never repeat the token back, and never put it in a link or a file you share.

## Status codes

| Code | Name | Meaning |
| --- | --- | --- |
| 200 | OK | It worked. The answer is the object or list asked for. |
| 201 | Created | The object was created. Some endpoints send it back; others send an empty body. |
| 202 | Accepted | The work was started and finishes in the background - for example a video being processed ({ "status": "processing" }). Check back on the object. |
| 204 | No Content | It worked, and there is nothing to send back - for example after removing a staff member. |
| 301 | Moved Permanently | The address changed; follow the Location header. |
| 400 | Bad Request | The request was refused as sent: a required field is missing, a value has the wrong type or fails validation. The body says what - often as plain text. |
| 401 | Unauthorized | No token, or one that is invalid or signed out. Without ?ionic=true, some endpoints answer this with the HTML login page instead of JSON. |
| 402 | Payment Required | The content needs a subscription: the user has no price plan that unlocks it. |
| 403 | Forbidden | The token is valid but may not do this - the record belongs to someone else, or the user is not an admin. AI builder endpoints also answer 403 when the account is out of credits. |
| 404 | Not Found | No object with that ID or URL slug, or no such endpoint. |
| 409 | Conflict | It clashes with the current state: the item is already being processed, a version is already applied, or an AI plan or preview is no longer available. |
| 410 | Gone | It existed but is no longer there - for example a comment already deleted on the social network. |
| 412 | Precondition Failed | A rule the request must meet is not met - for example push notifications of the same type at least 48 hours apart. |
| 418 | I'm a teapot | An account confirmation or password reset link was used with an email that does not match it. |
| 421 | Misdirected Request | The domain is not a Builderly site. Call the site's own address. |
| 422 | Unprocessable Content | The request was understood but could not be done - for example the AI could not read the website it was asked to clone. The message says what to try instead. |
| 429 | Too Many Requests | Slow down: the site's request limit was reached, an AI chat already has a request running, or the hourly limit of AI search answers is used up. Wait and retry. |
| 500 | Internal Server Error | Something failed on the server. Retrying later may work; if it keeps failing, the request may be one the endpoint does not handle. |
| 502 | Bad Gateway | A service the request depends on failed - for example the address a redirect forwards to. |
| 503 | Service Unavailable | Used by the lead form when an order is below its minimum value, not only for outages: read the message. |

Errors do not share one shape: depending on the endpoint the body is plain text, { "error": "..." }, { "message": "..." } or empty. Rely on the status code, and show the body to the user as the reason.

## Endpoints

### Coupons & vouchers

Coupons are discount codes customers enter at checkout - a fixed amount, a percentage, free shipping or buy X get Y - limited to products, collections, events or a minimum subtotal. Vouchers are app-exclusive offers.

#### Coupon

##### Retrieve the coupon capture
`GET /coupon_capture`
Lightweight endpoint for the ionic app to trigger the couponCapture middleware. The middleware runs before this handler, validates ?coupon= and sets the pending_coupon cookie.
- Access: Public
- Status codes: 200

##### Retrieve the coupon code
`GET /coupon_code`
Returns if a coupon is valid.
- Access: Optional user
- Body:
  - `coupon_code` (string): The coupon code's coupon code.
- Status codes: 200, 404, 500
- Models: Coupon

##### List all coupon codes
`GET /coupon_code/:code`
Returns if a coupon is valid.
- Access: Optional user
- Path:
  - `code` (string): The coupon code's code.
- Status codes: 200, 404, 500
- Models: Coupon

##### List all coupon infos
`GET /coupon_info/:code`
Returns public coupon details by code without incrementing uses.
- Access: Public
- Path:
  - `code` (string): The coupon info's code.
- Status codes: 200, 404, 500
- Models: Coupon

##### List all coupons
`GET /coupons`
Returns the site's coupons, newest first unless a sort is given.
- Access: Public
- Returns: a list of Coupon objects.
- Status codes: 200, 500
- Models: Coupon

##### Create a coupon
`POST /coupons`
Create new coupon.
- Access: Admin token
- Returns: the Coupon object.
- Status codes: 201, 400, 401, 500
- Models: Coupon

##### Retrieve a coupon
`GET /coupons/:id`
Returns one coupon, found by its ID.
- Access: Public
- Path:
  - `id` (string): The ID of the coupon.
- Returns: the Coupon object.
- Status codes: 200, 404, 500
- Models: Coupon

##### Update a coupon
`PATCH /coupons/:id`
Update Coupon by id.
- Access: Admin token
- Path:
  - `id` (string): The ID of the coupon.
- Returns: the Coupon object.
- Status codes: 200, 400, 401, 404, 500
- Models: Coupon

##### Delete a coupon
`DELETE /coupons/:id`
Delete Coupon record by id.
- Access: Admin token
- Path:
  - `id` (string): The ID of the coupon.
- Returns: an empty answer on success.
- Status codes: 200, 401, 404, 500
- Models: Coupon

#### Voucher

##### List all vouchers
`GET /vouchers`
Returns the site's vouchers, newest first unless a sort is given.
- Access: Public
- Query:
  - `authenticated` (string): Only vouchers with this authenticated.
- Returns: a list of Voucher objects.
- Status codes: 200, 500
- Models: Voucher

##### Retrieve a voucher
`GET /vouchers/:id`
Returns one voucher, found by its ID.
- Access: Admin token
- Path:
  - `id` (string): The ID of the voucher.
- Returns: the Voucher object.
- Status codes: 200, 401, 404, 500
- Models: Voucher

#### AI builder

##### Create a coupon with AI
`POST /create-new-coupon`
Create a coupon from a prompt, written by the AI builder.
- Access: User token
- Body:
  - `prompt` (string): What the AI should do with the coupon, in plain words - any language.
  - `chatId` (string): The AI chat this request belongs to; its history and language carry over. Leave it out to start a new chat.
  - `aiVersion` (string): Which version of the AI builder to use; leave it out for the current one.
  - `item_id` (string): The ID of the coupon to change.
- Status codes: 200, 401, 500
- Models: ChatMessage

##### Generate a coupon with AI
`POST /generate-coupon`
Use it to create a new discount coupon or promo code.
- Access: User token
- Body:
  - `prompt` (string): What the AI should do with the coupon, in plain words - any language.
  - `chatId` (string): The AI chat this request belongs to; its history and language carry over. Leave it out to start a new chat.
- Status codes: 200, 401, 500

## Objects

### ChatMessage

- `chat_id`: ObjectId, required, → ChatHistory
- `role`: String, one of user | model
- `text`: String
- `target_url`: String
- `action`: String, one of RESPONSE | REDIRECT | OBJECT_RESPONSE | ERROR | CLARIFY | PROPOSED_ACTION
- `options`: String[]
- `data.object`: Mixed
- `data.object_type`: String
- `data.edit_summary`: Mixed
- `data.edit_diff`: Mixed
- `data.undo_record`: Mixed
- `data.hero_animation_offer`: Mixed
- `data.preview_state`: String
- `data.pending_credit_cost`: Number
- `data.target_restore`: Mixed
- `data.media_request`: Mixed
- `data.item_request`: Mixed
- `data.reference_request`: Mixed
- `data.section_options`: Mixed
- `data.section_blueprint`: Mixed
- `data.section_style_options`: Mixed
- `data.section_style_blueprint`: Mixed
- `data.section_role_picker`: Mixed
- `data.small_section_regeneration_options`: Mixed
- `data.small_section_regeneration_target`: Mixed
- `data.small_section_regeneration_prompt`: String
- `data.selected_small_section_action`: Mixed
- `data.component_regeneration_input`: Mixed
- `data.selected_section_role`: Mixed
- `data.selected_section_option`: Mixed
- `data.selected_section_style`: Mixed
- `data.section_options_target`: Mixed
- `data.section_options_prompt`: String
- `data.style_options_target`: Mixed
- `data.style_options_prompt`: String
- `data.previous_container`: Mixed
- `data.preserved_custom_components`: Mixed[]
- `data.selection_request`: Mixed
- `data.proposed_action`: Mixed
- `data.plan_result`: Mixed
- `data.parsed_intent`: Mixed
- `data.parsed_intent_version`: Number
- `data.parsed_intent_at`: Date
- `data.item_id`: ObjectId
- `data.design_archetype`: String
- `data.design_palette`: Mixed
- `data.out_of_credits`: Boolean
- `data.site_wide_edit`: Mixed
- `data.redesign`: Mixed
- `medias`: Object[]
  - `media`: ObjectId, → Media
  - `gcs_url`: String
  - `gemini_uri`: String
  - `gemini_interaction_id`: String
  - `_id`: ObjectId
- `products`: ObjectId[], → Product
- `services`: ObjectId[], → Service
- `blogposts`: ObjectId[], → BlogPost
- `programs`: ObjectId[], → Program
- `suggestions`: Object[]
  - `text`: String
  - `route`: String
  - `item_id`: ObjectId
  - `medias`: Mixed[]
  - `picture`: ObjectId
  - `_id`: ObjectId
- `is_system`: Boolean, default false
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date

### Coupon

A discount code for checkout.

- `code`: String, required - The coupon code customers enter at checkout (e.g. "SUMMER20", "SAVE10").
- `name`: String, required - Internal label for this coupon (e.g. "Summer Sale 20% Off").
- `fixed_discount`: Number - Fixed amount discount (e.g. 10 for $10 off).
- `percentage_discount`: Number - Percentage discount 1–100 (e.g. 20 for 20% off).
- `shipping_discount`: Number - Discount on shipping cost.
- `sale_discount`: Number - Sale price override.
- `quantity_discount.buy`: Number
- `quantity_discount.get`: Number
- `apply_to_all_orders`: Boolean
- `apply_to_all_products`: Boolean
- `apply_to_product`: String - Name of the specific product to apply to.
- `apply_to_event`: String - Name of the specific event to apply to.
- `apply_to_all_events`: Boolean
- `apply_to_collection`: String - Name of the specific collection/category to apply to.
- `apply_to_minimum_subtotal`: Number - Minimum order subtotal required.
- `start_date`: Date - ISO 8601 date when the coupon becomes active (e.g. "2026-03-20T00:00:00.000Z").
- `end_date`: Date - ISO 8601 expiry date (omit if no_end_date is true).
- `no_end_date`: Boolean, default false - Set to true if the coupon should never expire.
- `limit_uses`: Number - Max total uses (omit or set 0 for unlimited).
- `uses`: Number
- `_id`: ObjectId

### Voucher

- `title`: String
- `body`: String
- `media`: ObjectId
- `show_to`: String, default "0"
- `coupon`: ObjectId, → Coupon
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date