Skip to main content
POST
/
v1
/
proposals
Create a proposal from a template
curl --request POST \
  --url https://api.propal.io/v1/proposals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "slug": "<string>",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "theme_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "password": "<string>",
  "settings": {
    "allow_client_to_sign": true,
    "allow_client_to_deny": true,
    "allow_payment": true,
    "allow_client_to_download_pdf": true
  },
  "products": [
    {
      "bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment": {}
    }
  ],
  "proposal_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.propal.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key in format: pp_live_xxxxxxxxxxxxxxxxxxxxxxxx

Body

application/json
title
string
required
Minimum string length: 1
slug
string
required
Minimum string length: 1
template_id
string<uuid>
lead_id
string<uuid>
language
enum<string>
Available options:
fr,
en
theme_id
string<uuid>
password
string
settings
object
products
object[]
proposal_product_id
string<uuid>

UUID of an existing proposal_products row (NOT a bundle id) to attach to the new proposal.

Response

Created proposal

id
string<uuid>
required