Prepared for Acme Corp
" }, { "type": "text", "title": "Project Overview", "content": "We will redesign your website with modern UI/UX best practices, mobile-first responsive design, and SEO optimization.
" }, { "type": "pricing_table", "title": "Investment", "items": [ { "description": "Website Design & Development", "quantity": 1, "unit_price": 5000.00 }, { "description": "SEO Setup & Optimization", "quantity": 1, "unit_price": 1500.00 }, { "description": "Monthly Maintenance", "quantity": 12, "unit_price": 200.00, "is_optional": true } ] }, { "type": "signature", "title": "Agreement", "content": "By signing below, you agree to the terms outlined in this proposal.
" } ] } ``` ## Create from Template Instead of defining sections manually, pass a `template_id` to auto-populate sections from a saved template: ```json { "title": "New Client Proposal", "contact_id": 42, "template_id": 1 } ``` The template's sections and items will be copied into the new proposal. If you pass both `template_id` and `sections`, the explicit sections take priority. ## Update a Proposal **PUT** `/proposals/proposals/{id}` Update proposal fields and optionally replace all sections. When `sections` is provided, existing sections are removed and replaced with the new set. ```json { "title": "Updated Proposal Title", "status": "sent", "sections": [ { "type": "text", "title": "Revised Scope", "content": "Updated project scope details.
" } ] } ``` ## Clone a Proposal **POST** `/proposals/proposals/{id}/clone` Creates a full copy of an existing proposal including all sections and items. The clone: - Gets a new proposal number (PROP-XXX) - Title is prefixed with "Copy of" - Status is set to draft - Client signatures and sent/viewed timestamps are cleared - All sections and line items are duplicated No request body is needed. ## Apply Template to Existing Proposal **POST** `/proposals/proposals/{id}/apply-template` Replaces all sections on an existing proposal with sections from a template. ```json { "template_id": 3 } ``` **Warning:** This removes all existing sections and items on the proposal. ## List Proposals **GET** `/proposals/proposals` Query parameters: - `search` - Search by title or proposal number - `status` - Filter by status (draft, sent, viewed, signed, rejected, expired) - `contact_id` - Filter by contact - `company_id` - Filter by company - `sort` - Sort field (prefix with - for descending, e.g. `-created_at`) - `per_page` - Items per page (max 100) ## Get a Proposal **GET** `/proposals/proposals/{id}` Returns the full proposal with sections, items, contact, company, lead, template, activities, and converted invoice data. ## Delete a Proposal **DELETE** `/proposals/proposals/{id}` ## Section Types Reference | Type | Purpose | Supports Items | |------|---------|---------------| | cover | Cover page / title page | No | | text | Rich text content section | No | | pricing_table | Line items with pricing | Yes | | image | Image display section | No | | signature | E-signature capture section | No | | divider | Visual divider / separator | No | | columns | Multi-column layout | No | | video | Embedded video section | No | | spacer | Vertical spacing | No | ## Template API Templates can also be managed via the API: - **GET** `/templates/templates` - List templates (filter by `type=proposal`) - **POST** `/templates/templates` - Create a template (include `sections_data` array) - **GET** `/templates/templates/{id}` - Get a template with sections_data - **PUT** `/templates/templates/{id}` - Update a template - **DELETE** `/templates/templates/{id}` - Delete a template