Qwilr

App · 16 actions

Make Qwilr proposals and quotes from templates or saved blocks, publish and update them, see who accepted and the quote they chose, manage quote taxes and webhook subscriptions, and start a workflow when a page is made or accepted.

Actions

ActionWhat it does
Cancel webhook subscriptionCancel a webhook subscription so Qwilr stops sending to it.
Create page from saved blocksMake a Qwilr page from saved blocks in the order you choose, with your own quote sections, line items and variables.
Create page from templateMake a Qwilr page from one of your templates, filling in its variables.
Create taxAdd a tax your quotes can apply, such as GST at 10%.
Create webhook subscriptionHave Qwilr send one kind of page event, such as a page being accepted or viewed, to an https address.
Delete taxDelete a tax from your account.
Get pageGet one page with its status, links, expiry and payment settings, and once accepted, who accepted it, when, and the quote total they chose.
List pagesList your Qwilr pages, newest first, by status, tag, folder or owner, with their links.
List payment gatewaysList the Qwilr Pay payment gateways connected to your account.
List saved blocksList your saved blocks with their names, types and ids, to build pages from.
List taxesList the taxes your quotes can apply, with their rates.
List usersList the people in your Qwilr account with their emails, roles and teams, to choose a page's owner.
List webhook subscriptionsList the webhook subscriptions made through the API, with their events and addresses.
Replace page contentReplace everything on a page with saved blocks; the page keeps its id and links.
Update pagePublish or unpublish a page, set or stop its link expiry, move it to a folder, add tags, or turn Qwilr Pay on or off.
Update taxRename a tax or change its rate.

Cancel webhook subscription

Cancel a webhook subscription so Qwilr stops sending to it.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List webhook subscriptions' or 'Create webhook subscription'.

Outputs

deletedtrue/false
Always true once cancelled
subscription_idtext
The subscription cancelled
Example output
{
  "deleted": true,
  "subscription_id": "5f0c1e2d3b4a596877665544"
}

Create page from saved blocks

Make a Qwilr page from saved blocks in the order you choose, with your own quote sections, line items and variables. Each page made through the API uses a Qwilr credit, and once your credits run out Qwilr bills it on a monthly usage invoice.

Inputs

Saved blocksblock_idslistRequired
The saved blocks to build the page from, in the order chosen.
Block settingsblock_settingsobject
Settings for some of the blocks, keyed by the block's name or id. Each holds Qwilr's own fields: quoteSections and quoteSettings for a quote, substitutions, foldable, splashSettings or acceptSettings.
Page namenametext
The page's name, shown as its title in the browser.
Publish nowpublishedtext
Yes makes the page live so its link works; no (the default) keeps it a draft.One of: yes, no.
Variablessubstitutionsobject
Each variable's API reference (from the Variables menu in Qwilr's editor) with its value, shown exactly as given. A list of rows fills a repeating variable.
Tagstagslist
Tags for the page, separated by commas. Tags are case-sensitive.
Ownerowner_idtext
Who owns the page; their details appear in its emails. Defaults to the person whose token is connected.
Expire after (days)expire_after_daysnumber
Stop the page's link working this many days after it is published, 1 to 365. Leave empty for a link that does not expire.From 1 to 365.
Metadatametadataobject
Your own keys and values, such as a deal id, kept on the page and sent with Qwilr's webhooks.

Outputs

pageobject
The page
Example output
{
  "page": {
    "acceptance": null,
    "expiry": {
      "enabled": false
    },
    "folderId": null,
    "id": "6ee0f841f3cc8900090d82dc",
    "links": {
      "collaboratorUrl": null,
      "editorUrl": "https://app.qwilr.com/#/page/6ee0f841f3cc8900090d82dc",
      "pdfUrl": "https://pdf.qwilr.com/6ee0f841f3cc8900090d82dc.pdf",
      "publicUrl": "https://pages.qwilr.com/Proposal-for-Acme-a1B2c3D4e5F6"
    },
    "metadata": {
      "deal_id": "D-1001"
    },
    "name": "Proposal for Acme",
    "ownerId": "6ee0f841f3cc8900090d8200",
    "paymentSettings": {
      "enabled": false,
      "gatewayId": null,
      "requireOnAccept": false
    },
    "status": "draft",
    "tags": [
      "acme"
    ]
  }
}

Create page from template

Make a Qwilr page from one of your templates, filling in its variables. Each page made through the API uses a Qwilr credit, and once your credits run out Qwilr bills it on a monthly usage invoice.

Inputs

Template IDtemplate_idtextRequired
The template's id: the last part of the address while you edit it (app.qwilr.com/#/page/...). The whole address works too.
Page namenametext
The page's name, shown as its title in the browser.
Publish nowpublishedtext
Yes makes the page live so its link works; no (the default) keeps it a draft.One of: yes, no.
Variablessubstitutionsobject
Each variable's API reference (from the Variables menu in Qwilr's editor) with its value, shown exactly as given. A list of rows fills a repeating variable.
Tagstagslist
Tags for the page, separated by commas. Tags are case-sensitive.
Ownerowner_idtext
Who owns the page; their details appear in its emails. Defaults to the person whose token is connected.
Expire after (days)expire_after_daysnumber
Stop the page's link working this many days after it is published, 1 to 365. Leave empty for a link that does not expire.From 1 to 365.
Metadatametadataobject
Your own keys and values, such as a deal id, kept on the page and sent with Qwilr's webhooks.
After accepting, go toredirect_urltext
A web address to send people to once they accept. The template needs an Accept block.
Button text after acceptingredirect_button_labeltext
The button that takes them there. Defaults to Continue.

Outputs

pageobject
The page
Example output
{
  "page": {
    "acceptance": null,
    "expiry": {
      "enabled": false
    },
    "folderId": null,
    "id": "6ee0f841f3cc8900090d82dc",
    "links": {
      "collaboratorUrl": null,
      "editorUrl": "https://app.qwilr.com/#/page/6ee0f841f3cc8900090d82dc",
      "pdfUrl": "https://pdf.qwilr.com/6ee0f841f3cc8900090d82dc.pdf",
      "publicUrl": "https://pages.qwilr.com/Proposal-for-Acme-a1B2c3D4e5F6"
    },
    "metadata": {
      "deal_id": "D-1001"
    },
    "name": "Proposal for Acme",
    "ownerId": "6ee0f841f3cc8900090d8200",
    "paymentSettings": {
      "enabled": false,
      "gatewayId": null,
      "requireOnAccept": false
    },
    "status": "draft",
    "tags": [
      "acme"
    ]
  }
}

Create tax

Add a tax your quotes can apply, such as GST at 10%. Returns its id, which quote settings use to apply it.

Inputs

NamenametextRequired
The tax's name, shown on quotes.
Rate (%)ratenumber
The rate as a percentage, such as 10 or 7.5. Leave empty for a tax with no rate.At least 0.
Your own IDcustom_idtext
An id of your own for the tax, such as one from your accounting system. Qwilr makes one if left empty. It can't be changed later.

Outputs

taxobject
The new tax
Example output
{
  "tax": {
    "id": "tax_gst",
    "name": "GST",
    "rate": 10
  }
}

Create webhook subscription

Have Qwilr send one kind of page event, such as a page being accepted or viewed, to an https address.

Inputs

EventeventtextRequired
Which page event to send.One of: pageAccepted (Page accepted), pagePartiallyAccepted (Page partly accepted), pagePreviewAccepted (Page preview accepted), pageViewed (Page viewed), pageFirstViewed (Page viewed for the first time), pageSetLive (Page set live), pageRevivedLive (Expired page made live again).
Addresstarget_urltextRequired
The https:// address Qwilr sends each event to.

Outputs

subscriptionobject
The new subscription
Example output
{
  "subscription": {
    "event": "pageAccepted",
    "id": "5f0c1e2d3b4a596877665544",
    "url": "https://example.com/qwilr"
  }
}

Delete tax

Delete a tax from your account.

Inputs

Taxtax_idtextRequired
The tax. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
tax_idtext
The tax deleted
Example output
{
  "deleted": true,
  "tax_id": "tax_gst"
}

Get page

Get one page with its status, links, expiry and payment settings, and once accepted, who accepted it, when, and the quote total they chose.

Inputs

Page IDpage_idtextRequired
The page's id, from 'List pages' or an earlier step. Its editor address works too.

Outputs

pageobject
The page
Example output
{
  "page": {
    "acceptance": {
      "accepters": [
        {
          "acceptedAt": "2026-11-10T09:30:00.000Z",
          "customForm": [],
          "email": "jo@example.com",
          "esigned": true,
          "legalEntity": "Acme Inc",
          "name": "Jo Bloggs"
        }
      ],
      "acceptersCount": 1,
      "acceptersTotal": 1,
      "auditTrailPdf": "https://pdf.qwilr.com/audit/6ee0f841f3cc8900090d82dc.pdf",
      "quote": {
        "amount": 1100,
        "amountExcludingTax": 1000,
        "quoteSections": []
      }
    },
    "expiry": {
      "enabled": false
    },
    "folderId": null,
    "id": "6ee0f841f3cc8900090d82dc",
    "links": {
      "collaboratorUrl": null,
      "editorUrl": "https://app.qwilr.com/#/page/6ee0f841f3cc8900090d82dc",
      "pdfUrl": "https://pdf.qwilr.com/6ee0f841f3cc8900090d82dc.pdf",
      "publicUrl": "https://pages.qwilr.com/Proposal-for-Acme-a1B2c3D4e5F6"
    },
    "metadata": {
      "deal_id": "D-1001"
    },
    "name": "Proposal for Acme",
    "ownerId": "6ee0f841f3cc8900090d8200",
    "paymentSettings": {
      "enabled": false,
      "gatewayId": null,
      "requireOnAccept": false
    },
    "status": "accepted",
    "tags": [
      "acme"
    ]
  }
}

List pages

List your Qwilr pages, newest first, by status, tag, folder or owner, with their links. Gets one set; to see more, run it again with the cursor it gives.

Inputs

Statusesstatuseslist
Only pages with one of these statuses.One or more of: draft, live, accepting (Partly accepted), accepted, declined (Declined or expired), disabled.
Tagstagslist
Only pages with all of these tags, separated by commas. Use archived for archived pages.
Folder IDfolder_idtext
Only pages directly in this folder (not its sub-folders).
Ownerowner_idtext
Only pages this user owns.
Ordersorttext
By when each page was made. Defaults to newest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Qwilr's default is 25.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier run, with the same filters, to get the set after it.

Outputs

countnumber
How many in this set
next_cursortext
Pass as 'cursor' for the next set; empty on the last
pageslist
The pages, summarised
Example output
{
  "count": 1,
  "next_cursor": "",
  "pages": [
    {
      "createdAt": "2026-11-10T04:21:09.000Z",
      "folderId": null,
      "id": "6ee0f841f3cc8900090d82dc",
      "links": {
        "collaboratorUrl": null,
        "editorUrl": "https://app.qwilr.com/#/page/6ee0f841f3cc8900090d82dc",
        "pdfUrl": "https://pdf.qwilr.com/6ee0f841f3cc8900090d82dc.pdf",
        "publicUrl": "https://pages.qwilr.com/Proposal-for-Acme-a1B2c3D4e5F6"
      },
      "metadata": {
        "deal_id": "D-1001"
      },
      "name": "Proposal for Acme",
      "ownerId": "6ee0f841f3cc8900090d8200",
      "status": "live",
      "tags": [
        "acme"
      ]
    }
  ]
}

List payment gateways

List the Qwilr Pay payment gateways connected to your account.

Inputs

None.

Outputs

countnumber
How many
gatewayslist
The payment gateways
Example output
{
  "count": 1,
  "gateways": [
    {
      "id": "gw_stripe_main",
      "name": "Stripe"
    }
  ]
}

List saved blocks

List your saved blocks with their names, types and ids, to build pages from.

Inputs

None.

Outputs

blockslist
The saved blocks
countnumber
How many
Example output
{
  "blocks": [
    {
      "id": "uCHq6B6_S1EqZ2pyam8YVfUldvoF-Q",
      "name": "Pricing",
      "type": "Quote"
    }
  ],
  "count": 1
}

List taxes

List the taxes your quotes can apply, with their rates.

Inputs

None.

Outputs

countnumber
How many
taxeslist
The taxes
Example output
{
  "count": 1,
  "taxes": [
    {
      "id": "tax_gst",
      "name": "GST",
      "rate": 10
    }
  ]
}

List users

List the people in your Qwilr account with their emails, roles and teams, to choose a page's owner.

Inputs

None.

Outputs

countnumber
How many
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "createdAt": "2026-01-05T10:00:00.000Z",
      "email": "sam@example.com",
      "firstName": "Sam",
      "id": "6ee0f841f3cc8900090d8200",
      "lastName": "Lee",
      "roles": [
        {
          "name": "Admin"
        }
      ],
      "teams": [
        {
          "name": "Sales"
        }
      ]
    }
  ]
}

List webhook subscriptions

List the webhook subscriptions made through the API, with their events and addresses.

Inputs

None.

Outputs

countnumber
How many
subscriptionslist
The webhook subscriptions
Example output
{
  "count": 1,
  "subscriptions": [
    {
      "event": "pageAccepted",
      "id": "5f0c1e2d3b4a596877665544",
      "url": "https://example.com/qwilr"
    }
  ]
}

Replace page content

Replace everything on a page with saved blocks; the page keeps its id and links. Works only on pages made from saved blocks.

Inputs

Page IDpage_idtextRequired
The page's id, from 'List pages' or an earlier step. Its editor address works too.
Saved blocksblock_idslistRequired
The saved blocks to build the page from, in the order chosen.
Block settingsblock_settingsobject
Settings for some of the blocks, keyed by the block's name or id. Each holds Qwilr's own fields: quoteSections and quoteSettings for a quote, substitutions, foldable, splashSettings or acceptSettings.
Variablessubstitutionsobject
Each variable's API reference (from the Variables menu in Qwilr's editor) with its value, shown exactly as given. A list of rows fills a repeating variable.

Outputs

pageobject
The page
Example output
{
  "page": {
    "acceptance": null,
    "expiry": {
      "enabled": false
    },
    "folderId": null,
    "id": "6ee0f841f3cc8900090d82dc",
    "links": {
      "collaboratorUrl": null,
      "editorUrl": "https://app.qwilr.com/#/page/6ee0f841f3cc8900090d82dc",
      "pdfUrl": "https://pdf.qwilr.com/6ee0f841f3cc8900090d82dc.pdf",
      "publicUrl": "https://pages.qwilr.com/Proposal-for-Acme-a1B2c3D4e5F6"
    },
    "metadata": {
      "deal_id": "D-1001"
    },
    "name": "Proposal for Acme",
    "ownerId": "6ee0f841f3cc8900090d8200",
    "paymentSettings": {
      "enabled": false,
      "gatewayId": null,
      "requireOnAccept": false
    },
    "status": "draft",
    "tags": [
      "acme"
    ]
  }
}

Update page

Publish or unpublish a page, set or stop its link expiry, move it to a folder, add tags, or turn Qwilr Pay on or off. Only the fields given change.

Inputs

Page IDpage_idtextRequired
The page's id, from 'List pages' or an earlier step. Its editor address works too.
Publishedpublishedtext
Yes makes the page live; no takes it back to draft.One of: yes, no.
Expire after (days)expire_after_daysnumber
Stop the page's link working this many days after it is published, 1 to 365. Leave empty for a link that does not expire.From 1 to 365.
Stop link expirystop_expirytrue/false
Turn expiry off so the page's link keeps working.
Move to folder IDfolder_idtext
The id of the folder to move the page to.
Add tagsadd_tagslist
Tags to add, separated by commas, up to 30 characters each. The page keeps its other tags.
Take paymentspaymentstext
Turn Qwilr Pay on or off for the page.One of: yes, no.
Payment gatewaypayment_gateway_idtext
The gateway that takes the payments. Defaults to your account's default gateway.
Pay when acceptingrequire_payment_on_accepttext
Whether the buyer must pay as they accept.One of: yes, no.

Outputs

pageobject
The page
Example output
{
  "page": {
    "acceptance": null,
    "expiry": {
      "enabled": false
    },
    "folderId": null,
    "id": "6ee0f841f3cc8900090d82dc",
    "links": {
      "collaboratorUrl": null,
      "editorUrl": "https://app.qwilr.com/#/page/6ee0f841f3cc8900090d82dc",
      "pdfUrl": "https://pdf.qwilr.com/6ee0f841f3cc8900090d82dc.pdf",
      "publicUrl": "https://pages.qwilr.com/Proposal-for-Acme-a1B2c3D4e5F6"
    },
    "metadata": {
      "deal_id": "D-1001"
    },
    "name": "Proposal for Acme",
    "ownerId": "6ee0f841f3cc8900090d8200",
    "paymentSettings": {
      "enabled": false,
      "gatewayId": null,
      "requireOnAccept": false
    },
    "status": "live",
    "tags": [
      "acme"
    ]
  }
}

Update tax

Rename a tax or change its rate. Only the fields given change.

Inputs

Taxtax_idtextRequired
The tax. Pick one, or give its id from an earlier step.
New namenametext
A new name for the tax. Leave empty to keep it.
New rate (%)ratenumber
A new rate as a percentage. Leave empty to keep it.At least 0.

Outputs

taxobject
The tax as it is now
updatedtrue/false
Always true once updated
Example output
{
  "tax": {
    "id": "tax_gst",
    "name": "GST",
    "rate": 12.5
  },
  "updated": true
}

On this page