Patch proposal (draft)

curl --request PATCH \
  --url https://api.proposales.com/v3/proposals/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": 123,
  "language": "<string>",
  "title_md": "<string>",
  "description_md": "<string>",
  "recipient": {},
  "data": {},
  "blocks": [
    {}
  ],
  "attachments": [
    {}
  ],
  "background_image": {},
  "background_video": {},
  "contact_email": "<string>",
  "invoicing_enabled": true,
  "invoicing": {},
  "tax_options": {}
}
'

{
  "proposal": {
    "uuid": "<string>",
    "url": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.proposales.com/llms.txt

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

Use this endpoint when you want to change blocks, title, recipient, attachments, or other draft fields without creating a new version. For a new version (duplicate + apply body), use POST /v3/proposals/{uuid}. To update only the JSON data metadata blob with a shallow merge, use Patch proposal data.

​

Eligibility

• The proposal must exist (404 if the UUID is unknown).
• The authenticated user must be allowed to edit the proposal (401 if not).
• company_id in the body must match the proposal’s company (400 if not).
• Status must be draft or template. Other statuses return 409 (e.g. active, accepted).
• withdrawn proposals return 400.

​

Request body

The body is strict: only documented fields are accepted; extra keys return 400 with error.issues describing each problem (field path and message).

• company_id (number, required on every request) — must match the proposal’s company.
• At least one other field is required besides company_id (empty patches are rejected).

All other fields match Create proposal in shape, but they are optional: send only the keys you want to change. Omitted keys are left as-is on the server. Not accepted on this endpoint

• creator_email — use Create proposal only.
• status — not used for publishing; see warning above.

language

• Optional on the patch if the proposal already has a language and you are not changing blocks that depend on the content library.
• If you send blocks with content_id, you must supply language in the body or the proposal must already have a language stored.

​

Path

​

Common body fields

The following mirror Create proposal; all are optional except company_id, subject to the rules above.

​

Response

​

Status codes