Skip to main content

Documentation Index

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

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

This endpoint is used by the Portal.io Zapier integration. It fires when a change order’s status changes in your Portal.io account. A change order is a child proposal linked to a parent proposal. The payload is identical to the Proposal Status Change trigger. The system automatically routes the event as a change order trigger when the proposal has a parent.

​
Endpoint

GET /zapier/trigger/proposal

​
Headers

HeaderRequiredDescription
AcceptYesMust be application/json

​
Response

A 200 response returns the full change order details. The payload structure is identical to the Proposal Status Change response — see that page for complete field documentation. 
{
  "id": 5001,
  "number": 1002,
  "name": "Smith Residence AV — Change Order #1",
  "status": "Submitted",
  "total": 1500.00,
  "customer": {
    "id": 88,
    "partyType": "Person",
    "contactType": "Client",
    "firstName": "Jane",
    "lastName": "Smith",
    "companyName": "",
    "contactEmail": "jane.smith@example.com",
    "contactEmailCC": "",
    "contactPhone": "(555) 123-4567",
    "location": {
      "id": 1,
      "street": "123 Main St",
      "suite": "Apt 4B",
      "city": "Austin",
      "postalCode": "78701",
      "state": "Texas",
      "stateAbbrev": "TX",
      "country": "United States",
      "phone": "(555) 123-4567"
    }
  },
  "proposalPdf": null,
  "proposalCsv": null,
  "installerPdf": null,
  "salesPerson": "John Doe",
  "salesPersonEmail": "john@example.com",
  "areas": [],
  "financialSummary": {
    "partsSubtotal": 1200.00,
    "partsTotal": 1200.00,
    "laborTotal": 300.00,
    "feeTotal": 0,
    "proposalSubtotal": 1500.00,
    "proposalTotal": 1500.00
  },
  "changeOrders": []
}
This endpoint is designed for the Portal.io Zapier integration. If you are building a direct integration, consider using the webhook subscription endpoints instead.