Agreements API

​

Before you start

1. Create the lead (or use a case): Create a lead.
2. Open the template (Settings > Templates > Agreements), then its Settings tab, and open API for the template ID and a request with the template’s own field names.
3. For the API to send a template, it needs sign areas. A Word template with sign-here placeholders (client_signature, client_sign_date, rcic_signature and so on) has them. GET /template/list says sendable: true for those that do.

​

Make it and send it

curl -X POST "https://api.vflo.app/api/public/agreement/create" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leadId": "VFLO_LEAD_ID",
    "templateName": "Initial Consultation Agreement",
    "send": true,
    "values": { "consultation_duration": "60 minutes", "consultation_fee": "$150.00" },
    "metadata": { "booking_id": "savvycal-8842" }
  }'

• The client signs first; the firm signs after, in VisaFlo. Until then the status is awaiting_countersign.
• values sets the template’s variables by exact name. Whatever you leave out fills from the record, the lead’s customFields of the same name, or the template’s default. Money and dates are written the way your workspace writes them.
• signers is optional: without it, the record’s own contact signs. For more people, send "signers": [{ "role": "Client", "name": "Jane Doe", "email": "jane@example.com" }, { "role": "Spouse", "email": "sam@example.com" }].
• subject and message change the invitation email.
• metadata is your own reference. It comes back on every read and in every webhook event.
• The same call within 24 hours returns the first agreement with "duplicate": true and sends nothing twice, so retries are safe.
• Everything is checked before anything is sent. If it can’t go, you get a 422 with a code (missing_fields, no_sign_areas, no_signer_email and so on) and the list of problems in data.issues.

​

Follow it

curl "https://api.vflo.app/api/public/agreement/VFLO_AGREEMENT_ID" -H "X-API-Key: YOUR_API_KEY"

​

Download the signed PDF

curl -o signed.pdf "https://api.vflo.app/api/public/agreement/VFLO_AGREEMENT_ID/document/DOCUMENT_ID?version=signed" -H "X-API-Key: YOUR_API_KEY"

​

Zapier and Make

• Send "send": "true" as text if your tool only sends text.
• Map fields to values__consultation_fee, signers__Spouse__email and metadata__booking_id when the tool can’t build nested JSON.
• Numbers and booleans can be sent as text.

​

Limits

• No cancel or delete through the API yet. Do that in VisaFlo.
• 50 values keys, 20 metadata keys, 6 signers.